53c91ee89e
* Initial commit for i18n support * Bring out index page * Lint modified: src/pages/index.js * More Crowdin ephemera * copy src content to i18n/**/docusaurus-plugin-content-docs/current folders * run write-translations * remove superflous files in i18n * fix formatting * remove icons folders from translations, add ja, pt, vi translations * fix formatting * update translation JSON files * add crowdin support & crowdin:sync command, sync with crowdin * exclude failing locales * remove i18n from git cache, add write-heading-ids script * add crowdin:sync to before_install.sh script * add write-i18m shortening script & crowdin:download script (also to before_install.sh) * move crowdin:download from before_install.sh to prebuild hook * remove prebuild hook * remove crowdin script, bump deps * re-add cli/usage * update package-lock.json * add translation sync to build.sh for master * update README * add ja to localesNotBuilding, write e-ids * fix formatting * get on sync with master * replace check for master branch * change build script to work on travis * use refs instead of names * fix build.sh * replace head ref check with channel check * get stable channel in build.sh * remove zip * remove header ids Co-authored-by: rmshea <8948187+rmshea@users.noreply.github.com> |
||
|---|---|---|
| .. | ||
| .travis | ||
| art | ||
| src | ||
| static | ||
| .eslintignore | ||
| .eslintrc | ||
| .gitignore | ||
| .prettierignore | ||
| README.md | ||
| babel.config.js | ||
| build-cli-usage.sh | ||
| build.sh | ||
| convert-ascii-to-svg.sh | ||
| crowdin.yml | ||
| docusaurus.config.js | ||
| offline-cmd-md-links.sh | ||
| package-lock.json | ||
| package.json | ||
| publish-docs.sh | ||
| set-solana-release-tag.sh | ||
| sidebars.js | ||
| yarn.lock | ||
README.md
Docs Readme
Solana's Docs are built using Docusaurus 2 with npm.
Static content delivery is handled using vercel.
Installing Docusaurus
$ npm install
Local Development
This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server. (You might have to run build.sh first if you run into failures)
$ npm run start
Build Locally
This command generates static content into the build directory and can be
served using any static contents hosting service.
$ docs/build.sh
Translations
Translations are sourced from Crowdin
and generated when master is built.
For local development use the following two commands in the docs directory.
To download the newest Documentation translations run:
npm run crowdin:download
To upload changes from src & generate explicit IDs:
npm run crowdin:upload
CI Build Flow
The docs are built and published in Travis CI with the docs/build.sh script.
On each PR, the docs are built, but not published.
In each post-commit build, docs are built and published using vercel to their
respective domain depending on the build branch.
- Master branch docs are published to
edge.docs.solana.com - Beta branch docs are published to
beta.docs.solana.com - Latest release tag docs are published to
docs.solana.com