Sysl website https://sysl.io is built using Docusaurus 2.
sysl // repo root
└── docs // documentation website content
├── blog // all the blogs
├── docs // all the docs
├── src
│ ├── css // common CSS
│ └── pages // landing page components and CSS
├── static // website assets
│ └── img
├── docusaurus.config.js // configuration
├── sidebars.js // sidebar management
├── package.json // dependencies and scripts
├── README.md // this file
└── yarn.lock // dependency version manifest
All documentation is Markdown files under docs/. Docusaurus 2 can do more than just parsing Markdown.
When adding images, useBaseUrl (instead of standard instead of Markdown image syntax) ensures the links will be correct when published.
- Create a new Markdown file in
docs/with a Docusaurus header. - Add it to
sidebars.js.
All blog posts are also Markdown files under blog/. Following the Docusaurus instructions to contribute to blog.
The homepage code of this website is in src/pages/index.js with configuration docusaurus.config.js. Follow configuration docs to contribute to Homepage.
yarn install
yarn start
This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server or refresh the browser.
yarn build
This command generates static content into the build directory and can be served using any static contents hosting service.
This project uses Prettier to format all files.
yarn format
A development version is deployed using Netlify. Deployment previews are enabled, so each PR has a unique deployment preview link which can be found in the Github Status Checks.
The markdown-link-check GitHub Action validates that the docs contain no broken links.
Algolia DocSearch is used for website searching. The crawler is configured in docsearch-config and runs daily.