Pimp your documentation in no time!
This getting started guide lets you quickly setup a static website using markdown files as a source.
# install globally using npm $ npm install -g @limedocs/cli # you can now use the limedocs CLI $ limedocs -v
# Pull the image $ docker pull limedocs/cli # Then use `docker-run` which will run the `limedocs` executable $ docker run --rm -ti limedocs/cli -v
Simply run the
create site command to create your new site. Limedocs will use its default starter (
@limedocs/starter-default) as an example. You can also use another starter available by providing its URL.
# This will create all directory tree in ./my-super-site $ limedocs create site my-super-site
# This will create all directory tree in ./my-super-site $ docker run -v `pwd`:`pwd` -w `pwd` --rm -ti limedocs/cli create site ./my-super-site
dev command to live edit your site without the hassle of setting up a server or hitting F5.
$ cd my-super-site/ $ limedocs dev
$ cd my-super-site/ $ docker run -v `pwd`:`pwd` -w `pwd` --rm -p 8889:8889 -ti limedocs/cli dev
→ Go to http://localhost:8889 to watch the result!
Let's take a look at your site structure:
my-super-site/ ├── limedocs-config.js ├── content/ ├── archetypes/ └── theme/
limedocs-config.jsis the main config file for your website (mandatory)
content/is where your put all your pages (mandatory)
archetypes/is where you put your site archetypes (optional)
content folder reflects your site structure: it contains
A page is a document that will be rendered in your final website. A page consists of:
Sections let you group pages in logical groups. Section reflects your site directory tree and so can be nested.
Limedocs automatically build sections from:
contentfolder which contains a
If a sub-directory does not contain a
_index.md file, pages within this directory will be attached to the upper section. Lets see how this works:
my-doc-website/ └── content/ ├── features │ ├── _index.md # Make "features" a section │ ├── awesome-feature.md # page within the section │ └── super-feature.md # another page ├── index.md # your homepage └── how-to # Warn: this is NOT a section as it does not contain a _index.md file ├── index.md # these 3 pages will be ignored ├── how-to-walk.md └── how-to-run.md
Root directories should always contain
_index.md files to be considered as sections, otherwise nested directories within them won't be indexed.
Archetypes are content files in the
archetypes folder of your project that contain preconfigured front matter for your website’s content types. Archetypes are optional but facilitate consistent metadata across your website content and allow you to quickly generate instances of a content type via the
limedocs create page command. See Archetypes for more.
theme folder is where you can override some of the theme files your are using. This is where you put your
static folder as well. See Themes for more.
$ cd my-doc-website $ limedocs create page content/first-section/article-2.md