serious загрузка - serious исходный код скачать

serious

Другие категории

v1.2.2

Скачать

Серьезно (серьезная фантастика)

Серьезный - это структура для создания эпизодической (или сериализованной) художественной литературы для Интернета. Он принимает ряд исходных файлов, записанных в формате Markdown, и собирает эти файлы в простое, общеприличное веб-приложение для вашего веб-хоста.

Смотрите пример историю.
Домашняя страница.
Репо для пакета CLI.
Репо для двигателя рендеринга.
Темы CSS.

MIT Лицензия.

Функции

Напишите в Markdown.
Разработано для (и только для) эпизодического контента, с нуля.
Пользователи могут легко получить доступ к списку эпизодов, просмотреть самые последние эпизоды или начать с самого начала.
Поддержка пользовательских тем CSS.
Комментарии через Disqus. Просто подключите короткое имя и идите.
Поддержка Google Analytics; Просто подключите идентификатор отслеживания.
Высоко настраивается.
Разработано для авторов, которые не могут иметь опыт в веб -разработке (как я!).
Генерирует простую статическую веб-страницу-и в любом месте.
Единственное приложение, но эпизоды по -прежнему имеют уникальные URL -адреса, потоки Disqus, записи истории/навигации и т. Д.

Установка и начало работы

Установите через NPM: npm install -g serious-fiction

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

В идеале вы должны создать свою историю в пустом каталоге. Запустите serious init в каталоге, чтобы начать работу.

Запустите serious build , чтобы восстановить свою историю и serious serve , чтобы просмотреть ее на местном уровне. Вы можете объединить эти две команды (например, serious build serve или serious serve build ), чтобы быстро построить и просмотреть историю. Вы также можете запустить serious build и обновить вкладку браузера (иногда, возможно, нужно жестко обновить, то есть Ctrl + F5 ), чтобы увидеть обновления без необходимости снова обслуживать веб -сайт.

Серьезно использует Ajax, поэтому вам нужно обслуживать его через Localhost, вы не можете просто открыть файл index.html .

Конфигурация

Когда вы запускаете serious init , в ваш каталог будет добавлен файл config.json . В будущем я надеюсь сделать эту часть CLI, но сейчас вам нужно отредактировать его вручную. Похоже, по умолчанию:

{
    "title" : " The Title of Your Story " ,
    "displayTitle" : " " ,
    "subtitle" : " " ,
    "description" : " A description of your website (for web searches) goes here. " ,
    "copyright" : " &copy; [year] [your name]. All rights reserved. " ,
    "posts" : " episodes " ,
    "input" : " ./src " ,
    "output" : " ./publish " ,
    "links" : [
        { "text" : " Website " , "url" : " https://twinelab.net " , "label" : " Learn more about Serious. " },
        { "text" : " Blog " , "url" : " https://twinelab.net/blog " , "label" : " Visit my blog. " }
    ],
    "recentMax" : 5 ,
    "recentsExcerpts" : 1 ,
    "episodesExcerpts" : 3 ,
    "debug" : false ,
    "disqusShortname" : " " ,
    "googleAnalytics" : " " ,
    "cookieWarning" : true ,
    "nswf" : false ,
    "version" : " latest "
}

Вариант	По умолчанию	Описание
`title`	`"The Title of Your Story"`	Это имя вашей истории. Он появляется на странице недавних эпизодов и на странице списка эпизодов, а также на вкладке браузера. Комментарии DISQUS подводятся к названию, поэтому вы, вероятно, не захотите изменить его.
`displayTitle`	`""`	Если вы поместите здесь что -то между цитатами, это заменит вас везде везде в вашей истории, чтобы с комментариями Disqus.
`subtitle`	`""`	Это появляется под главным заголовком истории на некоторых страницах. Вы можете использовать его как линию, подзаголовок или действительно краткое описание.
`description`	`"A description of your website (for web searches) goes here.`	То, что вы вкладываете здесь, не появляется на каких -либо страницах, но вместо этого перечислено на некоторых веб -сайтах, таких как поисковые системы или сайты социальных сетей, наряду со ссылками на историю.
`copyright`	`"© [year] [your name]. All rights reserved."`	Уведомление об авторском праве может отображаться в самом нижней части каждой страницы, чуть выше, где `"Powered by Serious."` Сообщение. Вам не обязательно использовать это для информации об авторском праве. `©` это код HTML для © (символ авторского права).
`posts`	`"episodes"`	Эта опция может быть использована для изменения слова, используемого для обозначения ваших постов эпизода, чтобы вы могли изменить это на что -то еще, например, `"chapters"` или `"verses"` , основанные на ваших потребностях.
`input`	`"./src"`	Это говорит о серьезном, где искать ваши сообщения, относительно `config.json` . Пропустите его папку, и она будет рекурсивно искать ее для файлов Markdown (которые имеют расширение `.md` ), чтобы превратиться в посты. Как правило, вам не нужно менять это, просто поместите все свои посты в папке `src` .
`output`	`"./publish"`	Подобно вышесказанному, это говорит о серьезном, где разместить свою настроенную веб -страницу и откуда ее запустить. Опять же, вам, как правило, не нужно менять это.
`links`	`...`	Вы можете добавить ссылки в меню боковой панели, используя эту опцию. Каждая ссылка должна выглядеть следующим образом: `{ "text": "Click here", "url": "www.somesite.com", "label": "this is a tooltip!" }` . Свойство `text` управляет текстом отображения ссылки, а `url` - это то, где ссылка идет при нажатии. Пропей `label` появляется в виде подсказки инструментов, когда пользователь видит свою мышь по ссылке (используя атрибут `title` HTML). Вы можете использовать это для создания ссылок на личный блог, основной веб -сайт, Patreon и т. Д.
`recentMax`	`5`	Это контролирует, сколько эпизодов серьезных показывает на странице Recents (и на целевой странице).
`recentsExcerpts`	`1`	Это контролирует, сколько эпизодов в списке Recens показано их контент. Те, которые не показывают, показывают эллипс вместо этого (& halli;). Если вы хотите, чтобы весь контент был показан, установите это равное (или выше, чем) `recentMax` .
`episodesExcerpts`	`3`	Это контролирует, сколько эпизодов в списке эпизодов показывает свой контент, похожий на `recentsExcerpts` .
`debug`	`false`	Это включает функции отладки, включая журналы консоли и другие вещи. Обычно не нужно для большинства пользователей. Вероятно, убедитесь, что это ложь перед развертыванием.
`disqusShortname`	`""`	Вы можете настроить комментарии через Disqus. Тема комментариев будет добавлена в каждый эпизод, но не к мета -сообщениям, спискам и т. Д. Просто добавьте здесь свое короткое имя, дальнейшая конфигурация не требуется!
`googleAnalytics`	`""`	Вы можете настроить Google Analytics для вашей серьезной истории. Просто создайте учетную запись, введите URL вашего сайта, скопируйте и вставьте здесь идентификатор отслеживания.
`cookieWarning`	`true`	Добавляет, сгенерированное согласием cookie cookie, предупреждение вам в проекте. Если у вас есть собственное решение, или просто вам все равно, вы можете установить это на ложь. Сам Серьезный не использует файлы cookie, это требует их только в том случае, если вы используете Disqus и/или Google Analytics.
`nsfw`	`false`	Если True, добавляет полноэкранный диалог предупреждения, просящий пользователя подтвердить свой возраст, по умолчанию более 18. Вы можете изменить значение на число, например, `13` или `21` чтобы попросить пользователя подтвердить, что они превышают другие возрасты, вы можете желаю проверить.
`version`	`"latest"`	Версия двигателя рендеринга Serious для включения. «Последний» рекомендуется, но если вам нужно использовать другую версию, вы можете пометить ее здесь. Смотрите изменену ниже для списка версий.

Написание эпизодов

Вы можете написать эпизоды, используя ароматизированную маркировку GitHub. В верхней части каждого эпизода у вас должна быть фронтальная вещество Yaml, чтобы описать эпизод:

 ---
title: Example Episode
subtitle: Serious Examples for Serious People
episode: 1
description: Welcome to Serious!
---
This is an **example episode**!

Welcome to Serious. To create episodes, you create a heading block like the one at the top of this file, then write your *markdown format content* after that.

Параметр	Описание
заголовок	Название эпизода. Необходимый.
подзаголовок	Подзаголовок эпизода. Необязательный.
эпизод	Номер эпизода. Необходимый. Смотрите подробнее ниже.
описание	Краткое описание эпизода (не выдержка). Не требуется, но рекомендуется.

При прослушивании ваших эпизодов начните с 1 (не начинайте с 0, это приведет к ошибке), и убедитесь, что не удваиваются на каких -либо числах (также вызовет ошибку). Эпизоды также не должны быть редкими. Если есть эпизод 1 и эпизод 3, должен быть эпизод 2; Это не вызовет ошибку, но, вероятно, сломает сгенерированный веб -сайт.

Мета -посты

«Мета» посты - это специальные посты, которые существуют вне обычной структуры эпизода. Такие вещи, как страница, резки и т. Д. Мета, автоматически добавляются в боковую панель в качестве ссылок; Нажатие на эти ссылки видят Meta Post. Чтобы создать один, убедитесь, что параметр episode в передней материи - meta , а не число. Существует также дополнительный параметр link , который можно использовать для изменения текста ссылки на боковой панели; Если параметр link не предоставлен, title используется вместо этого. Если вы установите параметр link на _ (единственное подчеркивание), чтобы предотвратить создание ссылки на боковой панели вообще.

 ---
title: About My Story
link: About
label : Learn more...
subtitle: This is a meta post!
episode: meta
description: Meta posts are awesome!
---
By creating a post and making it's episode property in the header `meta` instead of a number, you can create a *meta post*, which will automatically appear as a link in the sidebar.

Параметр label добавляет атрибут заголовка (и «подсказка») к сгенерированной ссылке в боковой панели.

Параметры мета -сообщения в остальном такие же, как обычный эпизод. Обратите внимание, что названия мета -постов должны быть уникальными; Эпизоды не имеют этого ограничения (хотя это мудро).

URL -схема

Вы можете создавать ссылки на маркировку на конкретные эпизоды, создавая ссылки, которые выглядят так:

 [Last week](./?ep=10) our heroes...

Выше приведено, что создаст ссылку на эпизод 10. Чтобы создать ссылки на мета-посты, вам необходимо знать название, которое нормализуется и слабится (например, отделан. приборные). Например, если параметр title « About » становится ./?meta=about , а Where is This Going? станет ./?meta=where-is-this-going- .

Развертывание

Для развертывания веб -сайта требуется все в выводе ( publish по умолчанию). Скопируйте все файлы в ваше решение для хостинга для развертывания.

Темы

Некоторые темы CSS со мной.

Вы можете создать тему, отредактировав файл theme.css в выводичном каталоге. Вы можете восстановить по умолчанию или начать с удаления файла-новый, пустой файл theme.css будет создан в следующий раз, когда вы построите. Вы можете скачать и установить темы, перезаписывая тот же файл.

Структура проекта

В настоящее время в проекте есть три основных компонента: пакет NPM, который является серьезным CLI; репозиторий для двигателя рендеринга, сценариев и стилей, которые обслуживаются сгенерированным веб -приложению через CDN; и хранилище для тем, которые я сделал. Все эти компоненты могли бы сделать с некоторым приливанием, но суть в том, что эти три вещи разрабатываются в тандеме, но имеют мало общего друг с другом функционально.