If you want to contribute to nushell itself, see nushell/nushell/CONTRIBUTING.md and the contributor-book.
This website is based on Vuepress.
- Install Node.js
- Run
npm install
- Run
npm run dev
If you're adding a new page to the book, to make it appear, put it also to .vuepress/config.js
.
- First of all, make sure you have installed
node.js
,yarn
, and then clone the doc repo locally:git clone [email protected]:nushell/nushell.github.io.git nu-docs
; - Run
yarn install
innu-docs
dir after your cloning; - Add a book dir(if not exists) for the specified locale in the docs' root folder, say
zh-CN
, and then create abook
child folder for all your translated documents, and a README.md for the home page of your locale; - Modify the vuepress config file
nu-docs/.vuepress/config.js
, addzh-CN
related configs, here is a commit for reference; - Add README.md in the
book
dir, and that will be the default introduction page of Nushell. Note: Please DO NOT translate the file name of the docs. - Run
yarn vuepress dev
, then open http://localhost:8080/ in your browser, switch to the language you are going to translate into, and you will see the introduction page you have just created. You can translate the docs and save them to get a preview in the browser; - Update the
nu-docs/i18n-meta.json
file, fill the locale value of the doc you have just finished. It's recommended to usecommit_id@author
or simply acommit_id
to indicate your translation end to the specified commit; - Commit your changes, It's recommended to squash all your commits in one commit with a commit message like this:
Translate your_doc_file.md to zh-CN from commit: f3dc86d3d
; - Send a Pull Request;
- Check outdated translations: You can use a command like
nu ./i18n.nu outdated zh-CN
to check the outdated translations(documents have been changed after your last translation) for the specified locale.