Страницы

Содержание веб-сайта находится в директории pages. Страницы могут быть написаны в Markdown, EJS или HTML. Структура папок внутри каталога pages отражает фактический путь запроса страницы (за исключением когда указан permalink), что означает, учитывая структуру ниже:

pages
├── about
│   └── team.md
├── about.md
├── documentation
│   ├── getting-started
│   │   ├── configuration.md
│   │   ├── index.md
│   │   └── _structure.md
│   └── i18n
│       ├── index.md
│       └── markdown.md
├── index.ejs
└── news.md

Когда сервер запусшен страницы могут быть доступны адресом ниже:

  • pages/about/team.md -> http://localhost:3000/about/team.
  • pages/documentation/i18n/index.md -> http://localhost:3000/documentation/i18n
  • index.ejs -> http://localhost:3000

Front Matter

Front Matter помогает легко определить метадаты(например: название страницы, описание и тд.) для страницы, например:

---
title: Front Matter
description: Front Matter is a powerful tool for adding metadata to the pages
categories: [documentation, i18n]
showToc: true
---
Подробнее

Типы страниц

Пока что CMintS поддерживает 3 вида страниц:

Markdown

Чтобы писать содержимое страницы используя Markdown, просто используйте .md как расширение к файлу. CMintS использует CommonMark для создания Markdown страниц:

---
title: About Markdown
description: Markdown is a lightweight markup language with plain text formatting syntax
---

## Subheading of the page

Here goes paragraph for the subheading

- list item1
- list item2
- list item3
Подробнее

ejs

ejs — это язык шаблонов и может быть использован для более сложных страниц. для того чтобы создать их просто создайте файл с расширением .ejs. ejs страницы могут также получить доступ к метаданным страницы и к помошникам.

---
items: 
  - Apples
  - Oranges
  - Cherries
---

<ul>
<% for (const item of page.items) { %>
  <li><%= item %></li>
<% } %>
</ul>
Подробнее

HTML

Используйте расширение .html для записи содержимого страницы в HTML.

---
title: About Markdown
description: Markdown is a lightweight markup language with plain text formatting syntax
---

<h2>Subheading of the page</h2>
<p>Here goes paragraph for the subheading</p>
<ul>
  <li>list item1</li>
  <li>list item2</li>
  <li>list item3</li>
</ul>

Черновики

Все страницы которые начинаются на _ являются черновиками, они только видимы или сгенерированы только тогда, когда используется флаг --draft на сервере, во время генерации или публикации. Эта страница не будет доступна иначе, так что вы можете использовать эти страницы и держать их скрытыми в производстве в то время как вы и ваша команда может продолжить работу над страницей.