This website is built using Docusaurus 2.
- Install packages
$ yarn
- Starts a local development server
$ yarn start
- Generate static content to serve on a static hosting service
$ yarn build
- Using SSH:
$ USE_SSH=true yarn deploy - Not using SSH:
$ GIT_USER=<Your GitHub username> yarn deploy
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.
- Page data (text and images) can be found in
static/data/- this content is then rendered in landing pages in
src/pages/
- this content is then rendered in landing pages in
- Docs and blog content would be written in
.mdxor.mdfiles indocs/, andblog/respectively
- Icon Library: Iconify
- Icones for web based icon library overview
- Iconify Intellisense vscode extension
- CSS Framework: Tailwind (see
tailwind.config.js,assets/css/main.css) - Wordpress Blog Integration: Wordpress to Docusaurus Plugin
- Code Formatting: Prettier (see
.prettierrc,.prettierignore) - Linting: Eslint (see
.eslintrc,.eslintignore) - Rendering markdown from js strings: react markdown parser
- Use the custom ` component for any markdown strings
- This component wraps the markdown parser in
<BrowserOnly>{() => <ReactMarkdown />}</BrowserOnly>and handles the lazy loading and imports, reducing the amount of code needed on each instance. - Reasons for this is that the reactmarkdown component needed to by dynamically imported to avoid import error. Being async on a ssg page caused hydration isues without the other code. the reactmarkdown component works fine without the extra code, but it does throw errors
- This component wraps the markdown parser in
- Use the custom ` component for any markdown strings