Modyo Docs

Instructions

• Clone this repo
• cd modyo-docs and install dependencies (yarn install)
• Start the development server (yarn docs:dev)
• Load the site at http://localhost:8080

For node 17+ and MacOS: export NODE_OPTIONS=--openssl-legacy-provider

Structure

All the site it's inside the /docs folder, and the main configuration it's in /docs/.vuepress, including the public folder (/docs/.vuepress/public)

The default language is Spanish. English translations are managed externally using Transifex. Any change to an English file will be overwritten by the tool.

- docs/
 - .vuepress/
 - es/platform/ # All docs in spanish
 - en/platform/ # All docs in english (autogenerated)
 - README.md # It's like an index. In this case is the home page

The main navigation and the sidebar are controlled by the configuration (/docs/.vuepress/config.js)

Routes

Any file (markdown files) follow the same structure of the file system plus the language. For example:

- platform/
 - foo/
  - README.md

The route should be /guides/foo/. If we add the same folder foo to the english language, should be /guides/foo/.

The main navigation and the sidebar are controlled by the configuration file (/docs/.vuepress/config.js)

Examples routes

Visit http://localhost:8080/es/ or http://localhost:8080/es/platform