History

Gabriel Luiz Freitas Almeida ea8865dc18 🔧 chore(docs): update docusaurus.config.js to use monokai theme for code highlighting, show copy button, and display line numbers 📝 docs(sidebars.js): add "guidelines/custom-component" and "components/custom" to the sidebar for better navigation and discoverability		2023-07-27 06:58:38 -03:00
..
docs	🔧 chore(chains.mdx): add import statement for Admonition component to improve code organization and readability	2023-07-27 06:58:35 -03:00
plugins	add docs with components	2023-07-18 15:08:00 -03:00
src	add docs with components	2023-07-18 15:08:00 -03:00
static	add docs with components	2023-07-18 15:08:00 -03:00
babel.config.js	add docs with components	2023-07-18 15:08:00 -03:00
docusaurus.config.js	🔧 chore(docs): update docusaurus.config.js to use monokai theme for code highlighting, show copy button, and display line numbers	2023-07-27 06:58:38 -03:00
index.d.ts	add docs with components	2023-07-18 15:08:00 -03:00
package-lock.json	🔧 chore(package.json): update dependencies	2023-07-27 06:58:37 -03:00
package.json	🔧 chore(package.json): update dependencies	2023-07-27 06:58:37 -03:00
README.md	add docs with components	2023-07-18 15:08:00 -03:00
sidebars.js	🔧 chore(docs): update docusaurus.config.js to use monokai theme for code highlighting, show copy button, and display line numbers	2023-07-27 06:58:38 -03:00
spell_add.sh	add docs with components	2023-07-18 15:08:00 -03:00
spell_check.sh	add docs with components	2023-07-18 15:08:00 -03:00
tailwind.config.js	add docs with components	2023-07-18 15:08:00 -03:00

README.md

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

$ yarn

Local Development

$ yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

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.