9aad86555c
This reverts commit
|
||
|---|---|---|
| .husky | ||
| .yarn | ||
| about | ||
| root-pages | ||
| src | ||
| static | ||
| .gitignore | ||
| .prettierignore | ||
| .prettierrc | ||
| Jenkinsfile | ||
| README.md | ||
| babel.config.js | ||
| docusaurus.config.js | ||
| package.json | ||
| tsconfig.json | ||
| yarn.lock | ||
README.md
Waku.org
The repository for waku.org website.
How to Run Locally
- Clone this repository
$ git clone https://github.com/waku-org/waku.org.git
- Install the dependencies:
$ yarn install
- Start the website:
$ yarn start
- Visit
http://localhost:3000in your browser
Landing Page
The code for a landing page is located in src/pages/index.mdx. This file employs the mdx format and utilizes React components from the Logos Docusaurus Plugins package.
Adding Subpages
To include subpages, create a .md or mdx file within the about directory. You can use Frontmatter to add metadata to your markdown file.
The content in about/index.md will be utilized as the index page for the /about section.
Root Pages
Subpages that do not belong to the About page (e.g., Terms of Use) can be situated in the root-pages directory.
Docusaurus Config
You can find instructions for adding additional documentation sections, implementing localization, and managing versioning on the Docusaurus website.
Please note that theme customization is somewhat restricted; for more detailed instructions on customizing your theme, visit the Logos Docusaurus Theme repository.
Custom CSS
By default, this template utilizes the CSS styles defined in the logos-docusaurus-plugins package. You have the option to define custom CSS in src/css/custom.scss.
How to Run a Static Build (Production Build)
- Generate static files for production:
$ yarn build
The static files will be created in the build directory.
- Serve the static build:
$ yarn serve
CI/CD
- CI builds
masterand pushes todeploy-masterbranch, which is hosted at https://waku.org/. - CI builds
developand pushes todeploy-developbranch, which is hosted at https://dev.waku.org/.
The hosting is done using Caddy server with Git plugin for handling GitHub webhooks.
Information about deployed build can be also found in /build.json available on the website.
Change Process
- Create a new working branch from
develop:git checkout develop; git checkout -b my-changes. - Make your changes, push them to the
origin, and open a Pull Request against thedevelopbranch. - After approval, merge the pull request, and verify the changes on the staging server (e.g., https://dev.vac.dev).
- When ready to promote changes to the live website, rebase the
masterbranch on the staging changes:git checkout master; git pull origin master; git rebase origin/develop; git push.