This website is built using Docusaurus, a modern static website generator.
yarnyarn startThis command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
yarn start -- --locale esThis command makes the same than previous one, but opens the development for Spanish translation.
When an untranslated document is edited or a new feature is used that brings another button for example, it is our responsibility to maintain the respective translated files.
mkdir -p i18n/es/docusaurus-plugin-content-docs/current
cp -rn docs/** i18n/es/docusaurus-plugin-content-docs/current
mkdir -p i18n/es/docusaurus-plugin-content-blog
cp -rn blog/** i18n/es/docusaurus-plugin-content-blog
mkdir -p i18n/es/docusaurus-plugin-content-pages
cp -rn src/pages/**.md i18n/es/docusaurus-plugin-content-pages
cp -rn src/pages/**.mdx i18n/es/docusaurus-plugin-content-pagesThis set of commands will copy your untranslated Markdown files to the Spanish folder.
Any change made into the files need to be updated manually, to keep your translated sites consistent, when the docs/introduction.mdx doc is edited, you need backport these edits to i18n/es/docusaurus-plugin-content-docs/current/introduction.mdx.
yarn write-translations -- --locale esThis command will run again the write-translations CLI command to maintain the JSON translation files (for buttons, sidebar, navbar, etc.).
yarn buildThis command generates static content into the build directory and can be served using any static contents hosting service.
yarn build -- --locale esThis command makes the same than previous one, but generates static content for Spanish translation.
Using SSH:
USE_SSH=true yarn deployNot using SSH:
GIT_USER=<Your GitHub username> yarn deployIf you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.