> For the complete documentation index, see [llms.txt](https://wwydev.gitbook.io/mkdc/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://wwydev.gitbook.io/mkdc/zhi-nan/wen-jian-gui-ze.md).

# File rules

Markdown corresponds to a JSON file with the same name. When compiling, variables are searched in the JSON file. If a JSON file is not defined, it is considered that there are no variables in the Markdown file. In a project, main.md will be used as the entry file for compilation.

{% tabs %}
{% tab title="main.md" %}
{% code title="main.md" %}

```markdown
# Generated by markdown-compiler
## github
- [GitHub](<!--{v-github}-->)
```

{% endcode %}
{% endtab %}

{% tab title="main.json" %}
{% code title="main.json" %}

```json
{
    "github": "https://github.com/WwwwwyDev/markdown-compiler"
}
```

{% endcode %}
{% endtab %}
{% endtabs %}

### command

All instructions must start with "\<! -- {" and end with "} -->".

```markdown
<!--{v-your_variable}-->
<!--{if-your_variable}-->
<!--{ifn-your_variable}-->
<!--{for-your_variable}-->
<!--{forn-your_variable}-->
<!--{import-your_markdown_file_path}-->
```