- JavaScript 83%
- MDX 15.7%
- CSS 0.7%
- Dockerfile 0.6%
asmo
4662d1ed5d
All checks were successful
Build and publish docs image / publish (push) Successful in 5m36s
|
||
|---|---|---|
| .forgejo/workflows | ||
| .github/workflows | ||
| mdx | ||
| public | ||
| server | ||
| src | ||
| .dockerignore | ||
| .gitignore | ||
| cashu.space.code-workspace | ||
| Dockerfile | ||
| fly.toml | ||
| jsconfig.json | ||
| LICENSE.md | ||
| next.config.mjs | ||
| package-lock.json | ||
| package.json | ||
| postcss.config.js | ||
| prettier.config.js | ||
| README.md | ||
| tailwind.config.js | ||
| typography.js | ||
Cashu.space
Cashu.space website
Getting started
- Clone this repo.
- Install the dependencies
npm install(NB: if you're a previous contributor we have changed to using npm instead of yarn as of 27 Feb 2023) - Run the development server with
npm run dev - Access the site in development at http://localhost:3000
Forgejo image publishing
The repository is hosted at https://git.cashu.dev/cashubtc/docs.cashu.space. The GitHub source history and all 23 source branches were preserved during migration.
Pushes to main and manual runs on main build the Dockerfile for Linux/AMD64,
start the standalone server, and check the home page before publishing to
git.cashu.dev/cashubtc/docs.cashu.space. The tags are latest and
sha-<full commit SHA>. OCI labels identify the source repository and commit.
Use a verified image digest when updating a deployment.
The workflow uses the existing REGISTRY_USERNAME and REGISTRY_TOKEN secrets.
Optional Actions variables NEXT_PUBLIC_DOCSEARCH_APP_ID,
NEXT_PUBLIC_DOCSEARCH_API_KEY (a public search-only key), and
NEXT_PUBLIC_DOCSEARCH_INDEX_NAME are embedded at build time. Without these,
the documentation still builds but Algolia search is not configured.
The image serves HTTP on port 3000 as the node user. Image publication does
not update DNS or deploy the website. The legacy Fly workflow is restricted
to GitHub, so Forgejo pushes cannot trigger a Fly deployment.
Contributing
We're always looking for writers, coders, and translators to help us make Cashu.space more useful. You can see all the ways you can contribute or donate to the project in more details on our Contribute page.
License
This site is open source software under the MIT License. This site template is a commercial product and is licensed under the Tailwind UI license.
Protocol + Next.js
This site is based on the Protocol theme from Tailwind UI. It's built using Tailwind CSS and Next.js.
To learn more about the technologies used in this site template, see the following resources:
- Tailwind CSS - the official Tailwind CSS documentation
- Next.js - the official Next.js documentation
- Headless UI - the official Headless UI documentation
- MDX - the official MDX documentation
- DocSearch - the official DocSearch documentation