CodeX Docs — open-source приложение для документации — Разработка на vc.ru
У вас когда-нибудь возникала потребность поднять простое приложение для внутренней или публичной информации?
6105 просмотров
Сегодня мы выпустили большое обновление и представили мировому сообществу наш движок CodeX Docs, который используется внутри команды уже больше года. В этом посте — немного подробностей о проекте.
Коротко о проекте
CodeX Docs — сервис для работы с заметками. Простая установка, открытый исходных код, никаких ограничений. Проект основан на редакторе Editor.js и использует лучшие инструменты его экосистемы.
История возникновения
Когда мы выпускали Editor.js, возникла необходимость где-то писать и размещать документацию для разработчиков по использованию и настройке редактора. Мы в CodeX часто создаем инструменты для своих нужд и сами пользуемся своими продуктами. Так получилось и в этот раз — было решено писать документацию к редактору с помощью самого редактора, попутно лишний раз тестируя его.
Наш следующий релиз — open-source трекер ошибок Hawk также нуждался в документации, и тоже получил собственную копию CodeX Docs.
В то же время, внутри команды всевозможные документы мы писали в разных местаx: Apple Notes, Dropbox Paper, Google Docs, Notion. В какой-то момент проблема отсутствия Single Source of Truth стала слишком очевидной. Мы подняли копию CodeX Docs для внутренней документации. И это оказалось крайне удобно. Теперь все доки хранятся на space.codex.so, который закрыт от внешних посетителей с помощью Cloudflare Access.
Проект показал себя удобным и простым. Пришло время поделиться им с мировым сообществом.
Функциональность
В основе — редактор Editor.js, это наш крупный open-source проект, который недавно преодолел отметку в 20000 stars на GitHub.
Вокруг редактора сложилось большое сообщество пользователей и разработчиков плагинов. Лучше инструменты, расширения и библиотеки собраны в коллекции Awesome Editorjs. Все вместе они составляют экосистему Editor.
js.CodeX Docs построен на базе лучших решений экосистемы. Это всевозможные блоки редактора, плагины для настройки блоков, инструменты инлайн-форматирования.
Для работы проекта не требуется разворачивание сложной инфраструктуры, даже внешней базы данных. Все документы хранятся в виде JSON-файлов в папке .db
Документы можно вкладывать друг в друга, формируя разделы в сайдбаре. Менять порядок тоже, разумеется, можно. Каждой странице присваивается красивый URL, основанный на заголовке — это удобно для пользователей и хорошо для поисковой оптимизации.
В проекте заложено еще много удобных функций. Но главное, что код полностью открыт и каждый может предложить идею для улучшения или прислать готовое решение.
Сценарии использования
Проект получился удобным и полезным. Он может вам пригодиться если вам нужен проект для хранения:
- внутренней документации команды
- публичных инструкций и гайдов
- персональных заметок
Возможно, этим юзкейсы не ограничиваются.
Демо
Мы создали Demo Docs, где можно потестировать все «в движении». Контент там очищается каждые несколько минут.
Сегодня CodeX Docs был опубликован на Product Hunt. Мы будем рады, если вы ознакомитесь и оставите обратную связь.
CodeX Docs on Product Hunt
WordPress Codex — ценный помощник разработчика
Больше результатов…
Вы писали когда-нибудь функцию для вашей WordPress темы или плагина только для того, чтобы потом кто-то другой вам сказал «Но у WordPress уже есть функция для этого»? Большинство из нас сталкивались с такой ситуацией, потому что мы забываем посмотреть в Codex или даже в код WordPress.
Помните о доступных ресурсах
Проще сказать, чем сделать, я знаю. Когда вы в разгаре написания кода вашей темы или плагина, и вам нужна функция для чего-то конкретного, вы просто включаетесь и пишете свой собственный код. Но это не всегда соответствует принципу «Не повторять себя» (или, в данном случае, «Не повторять WordPress»). Когда вам нужна какая-то функция, по крайней мере проверьте WordPress Codex и посмотрите, может быть там уже есть что-то, что вы можете использовать.
Иногда вы можете найти функцию, упомянутую на странице Codex, но страница для данной функции пуста. Если так, попробуйте поискать эту функцию в коде WordPress и посмотреть, как она используется.
Некоторые полезные функции WordPress, о которых вы могли не знать
- human_time_diff — гораздо более дружественный в отношении пользователя способ для отображения времени, прошедшего с момента активности — сказать, что это было «5 минут назад» , а не «2012-03-19 16:43». Вот где пригодится эта функция! Передайте ей два момента времени для сравнения и она скажет вам разницу в минутах, часах, днях и т.д
- esc_js — эта функция проверки/форматирования данных пока еще не задокументирована в Codex, но по коду мы можем понять, как ее можно использовать. Если вам нужно использовать некий JavaScript, и у вас есть строка для его передачи, используйте
- calendar_week_mod — если вы делаете расчеты, основываясь на количестве недель, и вам нужно знать о каждой неполной неделе, эта функция сообщит вам, сколько дней прошло с начала недели.
- get_file_data — с этой функцией гораздо проще собирать мета-данные из заголовка файла (например информации, которая находится в начале файла style.css темы), плагина или шаблона страницы.
- add_rewrite_endpoint — эта функция может помочь всем, кто хочет добавить RESTful API к своему WordPress плагину или теме, или даже если вы хотите сделать что-то вроде адресов Bitly «+».
Замечание: если вы не знаете, что значит адрес Bitly «+», вот сокращенный сервисом Bitly адрес: http://bit. ly/CUjV, а вот страница информации для той же ссылки http://bit.ly/CUjV+. Видите разницу? Добавьте «+» к любому сокращенному Bitly адресу, чтобы посмотреть статистику.
Дружеский совет
Возможно, вы уже знали о существовании некоторых из этих функций, возможно, вы даже знали их все, но с каждой новой версией WordPress появляются новые вещи для изучения и для извлечения пользы от них. Не забывайте проверять Codex и WordPress код, чтобы найти там что-то для себя. Если вы смотрите Codex и нашли красную ссылку (то есть, на странице пока нет информации об этой функции/action и т.п.), посмотрите код! Код WordPress в большинстве своем хорошо прокомментирован, а где нет, обычно и без комментариев легко понять, что происходит.
Несомненно, вы работали с WordPress и встречали функции, о существовании которых не знали, а теперь вы не знаете, как вы могли жить без них. Расскажите о них нам в комментариях, чтобы мы тоже воспользовались вашим открытием!
Смотрите также:
Изучает сайтостроение с 2008 года. Практикующий вебмастер, специализирующий на создание сайтов на WordPress. Задать вопрос Алексею можно на https://profiles.wordpress.org/wpthemeus/
Подпишитесь на еженедельный дайджест про WordPress
Codex Определение и значение — Merriam-Webster
ко·декс ˈkō-ˌdeks
: рукописная книга, в частности Священного Писания, классических произведений или древних летописей
Знаете ли вы?
В 3-м и 4-м веках нашей эры кодекс начал заменять старый свиток как предпочтительную форму для более длинных текстов. В отличие от свитка, это замечательное изобретение позволяло писать на обеих сторонах листа, облегчало поиск определенного отрывка и могло содержать очень длинный текст. Кодексы (обратите внимание на эту необычную форму множественного числа) обычно писались на пергаменте, специально подготовленной коже овцы или козы, или на папирусе, предке бумаги. Поскольку кодексы были написаны от руки, копий любого отдельного кодекса было немного, а иногда и только одна копия. Сегодня мы больше не пишем наши книги от руки, но современная книга сохранила в основном ту же форму, что и первоначальные кодексы.
Примеры предложений
Недавние примеры в Интернете
Датируемый четвертым или пятым веками кодекс примечателен не только своим возрастом.
— Марк Дженкинс, Washington Post , 23 февраля 2023 г. Примечания в , кодекс , указывают на то, что его следующим управляющим был Салама бин Аби аль-Фахр, который должен был охранять его до тех пор, пока синагога не будет восстановлена.
— Сара Кута, Smithsonian Magazine , 17 февраля 2023 г.
Но синагога так и не была перестроена, и кодекс продолжал свою одиссею, пока не был приобретен Сассуном в 1929 году.
— Лианна Колирин, CNN , 15 февраля 2023 г.
Считается, что это самые первые
Эти примеры предложений автоматически выбираются из различных онлайн-источников новостей, чтобы отразить текущее использование слова «кодекс».
История слов
Этимология
Латинский — больше в коде
Первое известное использование
1661, в значении, определенном выше
Путешественник во времени
Первое известное использование кода было в 1661 г.
Другие слова того же года
Словарные статьи Рядом с
codexкодовое слово
кодекс
кодекс рескриптус
Посмотреть другие записи поблизости
Процитировать эту запись «Кодекс».
Словарь Merriam-Webster.com , Merriam-Webster, https://www.merriam-webster.com/dictionary/codex. По состоянию на 5 марта 2023 г.Копия цитирования
Медицинское определение
кодекс
существительное
ко·декс ˈkō-ˌдекс
: официальное или стандартное собрание формул и описаний лекарств
Кодекс, аналогичный Британскому Фармацевтическому Кодексу
Дополнительная информация от Merriam-Webster о
кодексеНглиш: Перевод кодекса для испаноязычных Последнее обновление: — Обновлены примеры предложений
Подпишитесь на крупнейший словарь Америки и получите тысячи дополнительных определений и расширенный поиск без рекламы!
Merriam-Webster без сокращений
Codex — New World Encyclopedia
Первая страница Codex Argenteus
A codex (лат. блок дерева, книга; множественное число0133 codices ) — это книга в формате, используемом для современных книг, с отдельными страницами, обычно связанными вместе и имеющими обложку. Хотя современная книга технически является кодексом, этот термин используется только для рукописей. Кодекс был римским изобретением, которое заменило свиток, который был первой книжной формой во всех евразийских культурах.
Содержание
- 1 Обзор
- 2 История
- 3 Социально-исторические контексты кодекса в раннем христианстве
- 4 См. также
- 5 Примечания
- 6 Каталожные номера
- 7 Внешние ссылки
- 8 кредитов
В то время как нехристианские традиции, такие как иудаизм, использовали свитки, ранние христиане использовали кодексы до того, как они стали популярными. Христианские ученые, похоже, использовали кодексы, чтобы отличать свои сочинения от еврейских научных трудов из-за разногласий и споров, особенно в отношении Ветхого Завета и других богословских сочинений. К пятому веку кодекс стал основным средством письма для общего пользования. Хотя практические преимущества формата кодекса способствовали его более широкому использованию, рост христианства в Римской империи, возможно, способствовал распространению его популярности.
Обзор
Хотя технически любая современная книга в мягкой обложке является кодексом, этот термин используется только для рукописных (написанных от руки) книг, выпущенных с поздней античности до средневековья. Научное изучение рукописей с точки зрения книжного ремесла называется кодикологией. Изучение древних документов вообще называется палеографией.
Кодикология (от латинского codex , родительный падеж cōdicis , «записная книжка, книга»; и греческий -λογία, -logia ) — это изучение книг как физических объектов, особенно рукописей, написанных на пергаменте в форме кодекса. Ее часто называют «археологией книги», поскольку она касается материалов (пергамент, иногда называемый мембраной или пергаментом, бумага, пигменты, чернила и т. д.) и методов, используемых для изготовления книг, включая их переплет. .
Палеография, палеография (британская) или палеография (американская) (от греческого παλαιός palaiós, «старый» и γράφειν graphein, «писать») — это изучение древнего почерка, а также практика расшифровки и чтения исторических рукописей. [1]
Кодексы Нового Света были написаны еще в 16 веке (см. кодексы майя и кодексы ацтеков). Те, что были написаны до испанских завоеваний, похоже, представляли собой отдельные длинные листы, сложенные гармошкой, иногда написанные на обеих сторонах местной бумаги аматль. Итак, строго говоря, они не в формате кодекса, но в их обычных названиях «Кодекс» более последовательно, чем в других типах рукописей.
Кодекс был усовершенствованным свитком, который он постепенно вытеснил сначала на Западе, а гораздо позже в Азии. Кодекс, в свою очередь, стал печатной книгой, для которой этот термин не используется. В Китае книги уже печатались, но только на одной стороне бумаги, и были промежуточные этапы, такие как свитки, сложенные гармошкой и склеенные сзади. [2]
История
Монограмма Чи Ро из Келлской книги
Страницы Кодекса Тро-Кортезиан (Мадрид) Кодекс майя
Ацтекские воины, изображенные во Флорентийском кодексе.
Основная форма кодекса была изобретена в Пергаме в третьем веке г. до н.э. Соперничество между Пергамской и Александрийской библиотеками привело к приостановке экспорта папируса из Египта. В ответ пергамцы разработали пергамент из овчины; из-за гораздо большего расхода приходилось писать на обеих сторонах страницы. Римляне использовали аналогичные предшественники, сделанные из покрытых воском деревянных табличек многоразового использования, для заметок и других неофициальных записей. Первое зарегистрированное использование кодекса римлянами для литературных произведений датируется концом I века 9.0201 CE , когда Марсьяль экспериментировал с форматом. В то время свиток был доминирующим средством для литературных произведений и оставался доминирующим для светских произведений до четвертого века. Юлий Цезарь, путешествуя по Галлии, счел полезным складывать свои свитки в стиле гармошки для более быстрого ознакомления, как позже сделали китайцы. Имеются свидетельства того, что еще в начале II века христиане предпочитали рукопись — обычно из папируса: в библиотеке Виллы Папирусов, Геркуланум (захоронена в 79 г. г. н.э. г.), все тексты (греческая литература) представляют собой свитки; в «библиотеке» Наг-Хаммади, засекреченной около 390 г. н.э. г., все тексты (гностико-христианские) являются кодексами. Самые ранние сохранившиеся фрагменты кодексов происходят из Египта и датируются по-разному (всегда ориентировочно) концом первого века или первой половиной второго. В эту группу входит папирус P52 библиотеки Райлендса, содержащий часть Евангелия от Иоанна и, возможно, датируемый периодом между 125 и 160 годами. [3]
В западной культуре кодекс постепенно заменил свиток. С четвертого века, когда кодекс получил широкое признание, до Каролингского Возрождения в восьмом веке многие работы, которые не были преобразованы из свитка в кодекс, были утеряны. Кодекс был лучше свитка по нескольким причинам. Его можно было открыть на любой странице, что облегчало чтение; страницы можно было писать как на лицевой, так и на оборотной стороне; а кодекс, защищенный прочной обложкой, был компактнее и удобнее в транспортировке.
Кодекс также упростил организацию документов в библиотеке, поскольку у него был устойчивый корешок, на котором можно было написать название книги. Корешок мог использоваться для инципита до того, как в средние века была разработана концепция правильного титула.
Хотя большинство ранних кодексов были сделаны из папируса, папирус был хрупким, и поставки из Египта, единственного места, где рос папирус, стали скудными; более прочный пергамент и пергамент завоевали популярность, несмотря на стоимость.
Кодексы доколумбовой Мезоамерики имели ту же форму, что и европейские кодексы, но вместо этого были сделаны из длинных сложенных полос либо из коры инжира (аматль), либо из растительных волокон, часто со слоем побелки, нанесенным перед письмом.
В Азии свиток оставался стандартным гораздо дольше, чем на Западе. Еврейская религия до сих пор сохраняет свиток Торы, по крайней мере, для церемониального использования.
Социально-исторический контекст кодекса в раннем христианстве
Свитки были доминирующей формой книги до того, как кодексы стали популярными. Одним из практических преимуществ кодекса является легкий доступ к нужной странице. Поскольку несколько листов связаны вместе на одном конце, как сегодняшние книги, пользователи могут открывать и переходить на нужную страницу, не просматривая страницы, предшествующие ей. Однако в прокрутке пользователи должны пройти весь путь, чтобы попасть на нужную страницу. Эта разница между свитками и кодексами в сегодняшней информационной среде аналогична разнице между аналоговыми запоминающими устройствами, такими как аудиокассеты и микрофильмы, и цифровыми запоминающими устройствами, такими как компакт-диски, DVD-диски и жесткий диск компьютера. В то время как в аналоговом устройстве пользователи должны пройти через другие части, чтобы добраться до нужной точки, пользователи могут напрямую добраться до точки, где информация хранится в цифровом устройстве.
Практическое преимущество кодекса — одна из причин, по которой кодекс заменил свиток. К пятому веку кодекс стал доминирующим и заменил свиток. Однако ранние христиане приняли кодекс гораздо раньше. В то время как большинство нехристианских источников до 300 г. г. н.э. хранилось в свитках, почти все христианские источники до 300 г. г. г. н.э. хранились в кодексах. [4]
Одна из причин, по которой христиане использовали кодекс, в отличие от использования свитков в иудаизме. Некоторые ученые, такие как Ларри Уртадо, утверждают, что христиане использовали кодекс, чтобы четко указать происхождение своих произведений, чтобы отличать их от еврейских ученых:
Среди христианских писаний, намеренно скопированных на свежие свитки, есть богословские трактаты, литургические тексты и магические писания. С другой стороны, христианские копии писаний Ветхого Завета и копии тех текстов, которые стали частью Нового Завета, написаны почти полностью в виде кодексов… Одной из причин этого могло быть указание на то, что данная копия библейского писания исходила из рук христиан. Теологические споры между христианами и евреями часто были сосредоточены на тексте писаний Ветхого Завета, каждый из которых обвинял другого во вмешательстве в текст, чтобы удалить оскорбительный материал или вставить отрывки, чтобы узаконить свои соответствующие убеждения. Возможно, что до печатных станков и издательских оттисков кодекс служил для указания читателям-христианам на то, что конкретная копия имеет надежное происхождение. [5]
Хотя практические преимущества формата кодекса способствовали его более широкому использованию, подъем христианства в Римской империи, возможно, способствовал распространению его популярности.
См. также
- Кодексы ацтеков
- Книга
- Кодексы майя
- Бумага
- Пергамент
- Свиток
- Веллум
Примечания
- ↑ «Палеография», Оксфордский словарь английского языка.
- ↑ Колин Чиннери. Международный проект Дуньхуан — несколько промежуточных китайских форм переплетного дела из C10-го века. Проверено 8 октября 2008 г.
- ↑ Тернер, Типология раннего Кодекса (Пенсильванский университет, 1977).
- ↑ Ларри Уртадо, Появление кодекса, Центр истории книги, Информационный бюллетень CHB, 2002.
- ↑ Там же.
Ссылки
Ссылки ISBN поддерживают NWE за счет реферальных сборов
- Хэнсон, К.С. Каталог новозаветных папирусов и кодексов 2-10 веков. Проверено 7 ноября 2008 г.
- Дирингер, Дэвид. Книга перед печатью: древняя, средневековая и восточная. Нью-Йорк: Dover Publications, 1982. ISBN 0486242439.
- Уртадо, Ларри. Появление кодекса. Центр истории книги, Информационный бюллетень CHB — 2002. Проверено 8 октября 2008 г. .
- Уртадо, Ларри В. Древнейшие христианские артефакты: рукописи и христианское происхождение. Гранд-Рапидс, Мичиган: паб William B. Eerdmans. Co, 2006. ISBN 9780802828958. .
- Робертс, Колин Х. и Теодор С. Скит. Рождение Кодекса. Лондон: Оксфордский ун-т. Пресса, 1989. ISBN 9780197260616.
- Тернер, Э.Г. Типология раннего Кодекса . Филадельфия: University of Pennsylvania Press, 1977. ISBN 9780812276961 .
Внешние ссылки
Все ссылки получены 7 марта 2017 г.