contentz
v3.14.1
Создать контент, получить высоко оптимизированный веб -сайт
css PROP и Tag Template cssУстановите его, используя NPM или пряжу с простой командой
yarn add contentz
# npm install contentz После того, как вы установили Contentz, вы можете использовать его с простой командой.
contentz buildЭто будет читать ваши файлы и генерировать ваш сайт для вас.
Создать файл конфигурации с именем config.yml
---
title : Sergio Xalambrí
description : Senior Software Engineer and Technical Writer
domain : https://sergiodxa.com
language : en
repository : https://github.com/sergiodxa/personal-site/
email : [email protected]
patreon : sergiodxa
analytics : UA-XXXXXXXXX-2
social :
twitter : sergiodxa
github : sergiodxa
npm : sergiodxa
linkedin : sergiodxa
dev : sergiodxa
meetup : 182915204
navigation :
- name : About
path : /about
- name : Services
path : /services| Вариант | Описание | Необходимый |
|---|---|---|
| заголовок | Название веб -сайта, используемое в <title> и на домашней странице | Нет (по умолчанию: Just another Contentz site ) |
| описание | Описание веб -сайта, используемого в <meta> и на домашней странице | Нет (по умолчанию: пустое описание) |
| домен | Домен, который вы собираетесь использовать для размещения веб -сайта, используемый в RSS -канале | Да |
| язык | Основной язык веб -сайта, используемый в качестве запасного для статей и страниц | Нет (по умолчанию: en) |
| репозиторий | Репозиторий GitHub, размещающий веб -сайт, используемый в нижнем колонтитуле статей и страниц | Нет (по умолчанию: скрыть ссылку на редактирование) |
| электронная почта | Ваш адрес электронной почты, используемый на значке электронной почты на домашней странице | Нет (по умолчанию: скрыть значок) |
| Патреон | Ваше имя пользователя Patreon, используемое на домашней странице и нижнем колонтитуле | Нет (по умолчанию: сообщение Hiden Patreon) |
| аналитика | Ваша аналитика UA | Нет (по умолчанию: скрыть аналитику) |
| социальная | Список ваших социальных сетей, используемый для ссылки на домашнюю страницу | Нет (по умолчанию: скрыть социальные значки) |
| навигация | Список страниц для ссылки в заголовке | Нет (по умолчанию: не добавляйте дополнительные ссылки) |
| дольдо | Установите его как false если вы хотите отключить поколение SW | Нет (по умолчанию: правда) |
| постепенный | Установите его как false если вы хотите отключить постепенную сборку | Нет (по умолчанию: правда) |
| икона | Установите путь к любимому сайте | Нет (по умолчанию: /static/favicon.png ) |
Для других социальных сетей отправьте пиар с новой иконкой и добавьте способ отформатировать URL для этой иконки.
Создайте папку /articles и поместите там свои файлы .mdx , вот пример поста.
---
title : My super cool article
description : This is the description of the article
date : 2018-01-01T00:00:00.000Z
published : true
---
This is my content, here I could use markdown or import a component and render it. Теперь запустите contentz , и он создаст A /public Directory с вашей домашней страницей, страницей архива и статьей. Вы можете получить доступ к своему архиву AT /articles/ и каждая статья как /articles/:article/ , в примере, вы можете увидеть его в /articles/my-super-cool-article .
Для пользовательских страниц создайте папку A /pages и поместите там свои файлы .mdx , вот примерная страница.
---
title : About me
---
Hi! I'm an example page. Теперь запустите contentz , и он создаст A /public Directory с вашей домашней страницей и страницами. Каждая страница будет размещена на базовом уровне public , что означает, что ваш /pages/about.mdx можно получить как /about/ в вашем браузере, а не /pages/about .
Если вы хотите иметь страницу, чтобы поделиться интересными ссылками, вы можете создать файл link.yml в корне вашего проекта. Затем запустите contentz , и он автоматически генерирует A /link/ Page для вас со списком всех ваших ссылок. Каждая ссылка должна иметь url , title , comment и ключ date . Пример файла:
---
- url : https://sergiodxa.com/
title : Sergio Xalambrí
comment : The website of the creator of Contentz
date : 2019-01-28T19:44:10.945Z
- url : https://sergiodxa.dev/
title : sergiodxa.dev
comment : The alias of the website of the creator of Contentz
date : 2019-01-28T19:44:10.945Z Contentz автоматически генерирует страницу ошибки на /404.html , когда вы можете перенаправить, не найденные страницы на /404.html .
Если вы развернете для NetLify, он автоматически забрал этот файл.
Contentz генерирует SW автоматически для вас, этот SW будет кэшировать каждый запрос на ваш собственный веб -сайт (используя location.origin ). Это не будет кэшировать запрос на другой домен.
Такое поведение может быть отключено добавление sw: false в ваш файл config.yml . Добавление этого также удалит de sw.js и load-sw.js чтобы избежать кэшированного доступа к и создать файл unload-sw.js .
Contentz будет автоматически генерировать действительный канал RSS -атома со списком статей, он будет размещен в /atom.xml , а тег <meta> будет автоматически добавлен для вас на каждой странице, чтобы сделать его открытым.
Если вы хотите ссылаться на статические файлы, такие как изображения, видео и т. Д. Создайте A /static папку и поместите все свои файлы. При запуске content они будут автоматически скопированы в /public/static
Если вы хотите добавить HTML -тег с пользовательскими стилями непосредственно в ваш контент MDX, вы можете использовать опору css и метку css шаблона эмоций.
Пример:
< div css = { { color : "red" } } > This is red </ div >
< div css = { css `color: blue` } > This is blue < / div> Contentz обнаружит, какие файлы изменились, и обновляет только соответствующие файлы. Это означает, что если вы добавите только новую ссылку /link/ будут восстановлены, но если вы измените статью, страницы статьи, список статей и RSS -канал будет восстановлен.
В случае обновления конфигурации или обновления версии ContentZ все страницы будут восстановлены.
Если вы хотите отказаться от этого набора функций incremental: false в вашем config.yml . Это автоматически аннулирует предыдущие кэши и всегда генерирует все страницы.
Contentz также может автоматически генерировать социальные изображения (AKA Open Graph) для использования в ваших статьях и страницах. Чтобы использовать его запустить команду:
contentz social [path] Где [path] - это файл, который можно использовать для создания социального изображения. Это также может быть более одного файла, добавляющего пространство между ними.
contentz social [path1] [path2]Путь может быть пути для статьи, поста или одной из страниц, сгенерированных авто.
Если вы хотите сгенерировать их изначально запустить
contentz social home articles links error После генерации социальных изображений вы увидите папку /static/_social с вашими изображениями, страницы будут размещены в/static _social /static/_social/article /static/_social/pages и статьи.
Поддержка Contentz i18n из коробки для фиксированных текстов веб -сайта, текст, как поддержка Patreon или редактировать на GitHub. Чтобы изменить основной язык вашего веб -сайта, установите ключевой language или ключевой lang (предпочитается язык) на языковой код.
Поддерживаемые языки - это es для испанского и en для английского языка (по умолчанию в английский в случае неверного языкового кода).
Если ваш язык не поддерживается, добавьте JSON с сообщениями и загрузите его в I18N LIB. Затем отправьте пиар, чтобы добавить его.
