Thank you for your support in Layotto!
This document describes how to modify/add documents. Documentation for this repository is written in Markdown.
Documents are stored in the 'docs/' directory, where 'docs/en' stores English documents and 'docs/zh' stores Chinese documents.
Files under docs/ directory will be automatically deployed to github pages and rendered through docsify.
Generally speaking, after the .md file is merged into the main branch, you can see the new page on the Layotto's documentation site, and all deployment and rendering processes are done automatically.
To add a document, create a folder and a .md file based on the directory structure. For example, if you want to write a design document for the distributed lock API, just create a new directory:
Remember to update the sidebar after adding new documents or revising existing documents.
Chinese sidebar: 'docs/zh/_sidebar.md'
English sidebar: 'docs/_sidebar.md'
After writing the above Markdown files, submitting pr and merging it into the main branch, new documents are now available on the official website.
One annoying problem with Docsify is that the use of hyperlinks are confusing.
The hyperlink mentioned here is the kind of links that will jump to other documents once clicked, such as the following:
If you try to create a hyperlink with a relative path, then a 404 page will appear once you clicked it:
There are two suggested ways to write hyperlinks:
a. Use a path relative to the 'docs/' directory. Such as:
b. Use the full Url. Such as:
see [runtime_config.json](https://github.com/mosn/layotto/blob/main/configs/runtime_config.json):Images are stored under docs/img/ directory for the purpose that the Docsify site can access it
It is recommended to use the full path when referencing images in documents, to avoid a bunch of messy path problems.
For example, when referencing the images under the main branch, the prefix of the image url is raw.githubusercontent.com/mosn/layotto/main/docs/img/xxx
and the Markdown phrase refering to an image will be ：
Note: Relative paths can also be used, but you may encounter many problems. For example, the relative path logic of the <img> tag and  tag are different; for example, users may access the README through different paths so that it's hard for you to define the relative path. To avoid these problems,it's recommended to use a full url.