doka-guide / platform

Платформа Доки: шаблоны, стили, скрипты и всё для сборки сайта

Home Page:https://doka.guide

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Платформа Доки

Статус линтера W3C Validator Статус деплоя Статус Docker

Дока — это добрая энциклопедия для веб-разработчиков. Наша цель — сделать документацию по веб-разработке практичной, понятной и не унылой.

Этот репозиторий содержит платформу для сайта «Дока». Платформа собирает статьи из отдельного репозитория.

Как устроен сайт

Сайт «Доки» работает на базе Eleventy. При помощи Nunjucks-темплейтов Eleventy превращает статьи в формате Markdown в HTML-страницы.

Проект собирается с помощью GitHub Actions и хостится на сервере, читайте подробнее про деплой.

Как работать

Для работы с платформой вам потребуется Node.js и npm.

Чтобы запустить Доку локально, нужно:

  1. Скачать репозиторий.
  2. Сделать копию файла .env.example и назвать его .env. Задать в нём нужные переменные окружения.
  3. Установить зависимости командой npm i.
  4. Запустить локальный веб-сервер командой npm start.

Больше вариантов локального запуска Доки — в руководстве по запуску.


Код распространяется по лицензии MIT, шрифты имеют собственные лицензии, подробнее читайте в документации.

ezoic increase your site revenue

About

Платформа Доки: шаблоны, стили, скрипты и всё для сборки сайта

https://doka.guide

License:MIT License


Languages

Language:JavaScript 39.4%Language:CSS 39.0%Language:Nunjucks 21.4%Language:Shell 0.2%Language:Dockerfile 0.1%