mwksl / meli-docs

Documentation of Meli, open source platform for deploying static sites and frontend applications.

meli-docs

Open source platform for deploying static sites and frontend applications.

Get started

1. Install dependencies npm run install
2. Run cp .env.example .env
3. Start npm start

Page info

You set metadata at the top of your Markdown files. It's not mandatory, but allows you to control SEO data.

---
title: 'page title'
excerpt: 'some description'
isHomePage: true | false
---

Special markdown blocks

Code blocks

Blank lines are important.

<div class="code-group">

\`\`\`yaml
# Your code here
\`\`\`

</div>

To show line numbers:

<div class="code-group" data-props='{ "lineNumbers": ["true"] }'>

\`\`\`yaml
# Your code here
\`\`\`

</div>

To add a file name:

<div class="code-group" data-props='{ "lineNumbers": ["true"], "labels": ["my-file.yaml"] }'>

\`\`\`yaml
# Your code here
\`\`\`

</div>

Info/Warning/Danger

Blank lines are important.

<div class="blockquote" data-props='{ "mod": "info" }'>

Your content here.

</div>

<div class="blockquote" data-props='{ "mod": "warning" }'>

Your content here.

</div>

<div class="blockquote" data-props='{ "mod": "danger" }'>

Your content here.

</div>

Algolia

You can find this info in your Algolia account under API keys.

ALGOLIA_ADMIN_KEY=
GATSBY_ALGOLIA_APP_ID=
GATSBY_ALGOLIA_INDEX_NAME=
GATSBY_ALGOLIA_SEARCH_ONLY_KEY=