CodeX Docs — open-source приложение для документации — Разработка на vc.ru
У вас когда-нибудь возникала потребность поднять простое приложение для внутренней или публичной информации?
5847 просмотров
Сегодня мы выпустили большое обновление и представили мировому сообществу наш движок 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
О Кодексе | CODEXALIMENTARIUS FAO-WHO
О Кодексе | CODEXALIMENTARIUS FAO-WHOPage tools
«К О Д Е К С А Л И М Е Н Т А Р И У С» – это гарантия безопасной и высококачественной пищи для каждого человека везде и повсюду.
Международная торговля продовольствием существует уже тысячи лет, но до недавнего времени производство продовольствие в основном было ориентировано на реализацию и потребление на местном уровне. За последнее столетие объем международной торговли продовольственными товарами значительно вырос, и сегодня количество и разнообразие продовольствия, перемещаемого по земному шару, велико как никогда.
Международные стандарты на пищевые продукты
«К О Д Е К С А А Л И М Е Н Т А Р И У С» международные стандарты, методические указания, нормы и правила способствуют обеспечению безопасности и качества пищевых продуктов, а также стимулируют добросовестную торговлю продовольственными товарами. Потребители могут быть уверены в безопасности и качестве покупаемых пищевых продуктов, а импортеры – в том, что заказанные ими продовольственные товары соответствуют своим спецификациям.
Защита здоровья потребителей
Обеспокоенность населения по поводу безопасности пищевых продуктов зачастую приводит к тому, что Кодекс оказывается в центре глобальных дискуссий. Ветеринарные препараты, пестициды, пищевые добавки и загрязняющие примеси – это лишь некоторые из вопросов, обсуждаемых на заседаниях Кодекса. Стандарты Кодекса опираются на достоверные научные данные, предоставляемые независимыми международными органами оценки риска либо посредством специальных консультаций, организуемых ФАО и ВОЗ.
Несмотря на то что стандарты Кодекса представляют собой рекомендации для добровольного применения членами, они часто используются в качестве основы для национального законодательства.
Устранение препятствий для торговли
Ссылка на стандарты безопасности пищевых продуктов Кодекса, приведенная в Соглашении о санитарных и фитосанитарных мерах (Соглашение СФМ) Всемирной торговой организации, свидетельствует о том, что Кодекс играет важнейшую роль в разрешении торговых споров. Членам ВТО, которые хотели бы применить более жесткие, по сравнению с Кодексом, стандарты безопасности пищевых продуктов, может быть предложено дать научное обоснование такого рода мер.
С момента своего создания в 1963 году система Кодекса развивается с соблюдением принципа открытости и широкого вовлечения заинтересованных сторон, отвечая на новые вызовы. Международная торговля продовольствием представляет собой индустрию с годовым оборотом 2000 млрд долларов и с объемами производства, реализации и перевозки, измеряемыми миллиардами тонн.
Предназначение «Кодекса Алиментариус»
«Кодекс Алиментариус» представляет собой свод представленных в едином формате международно принятых стандартов и родственных текстов, относящихся к пищевым продуктам. Эти стандарты и родственные тексты предназначены для защиты здоровья потребителей и обеспечения добросовестной торговли продовольствием. Публикации «Кодекса Алиментариус» ставят своей целью оказать методическое содействие и помощь в разработке определений и требований к пищевым продуктам, что позволило бы повысить уровень гармонизации требований и, за счет этого, способствовало бы развитию международной торговли.
Сфера применения «Кодекса Алиментариус»
«Кодекс Алиментариус» включает стандарты на все основные пищевые продукты независимо от того, являются ли они переработанными, полуфабрикатами или поступают потребителю в сыром виде. Продовольственное сырье, используемое для последующего изготовления пищевых продуктов, следует включать в той степени, в какой это необходимо для достижения целей «Кодекса Алиментариуc». «Кодекс Алиментариус» содержит положения о гигиене пищевых продуктов, а также о пищевых добавках, остатках пестицидов и ветеринарных лекарственных препаратов, загрязняющих примесях, маркировке и представлении, методах анализа и отбора проб, контроля и сертификации импорта и экспорта пищевых продуктов.
Суть стандартов Кодекса
Стандарты Кодекса и родственные тексты не являются заменой или альтернативой для национального законодательства. Законы каждой страны и административные процедуры содержат положения, которые необходимо соблюдать.
Стандарты Кодекса и родственные тексты содержат требования к пищевым продуктам, призванные обеспечить потребителя высококачественными и полезными для здоровья пищевыми продуктами, не содержащими примесей, ухудшающих качество исходного продукта, надлежащим образом маркированными и представленными. Стандарт Кодекса на любой пищевой продукт или группу продуктов должен разрабатываться в соответствии с «Форматом стандартов Кодекса на товары», и соответственно, содержать перечисленные в нем разделы.
Пересмотр стандартов Кодекса
Комиссия «Кодекс Алиментариус» и ее вспомогательные органы при необходимости могут вносить изменения в стандарты и родственные тексты Кодекса в целях приведения их в соответствие с современными научными знаниями и иной значимой информацией.
Если требуется, стандарт или родственный текст может быть изменен или отменен тем же самым порядком, каким разрабатывается новый стандарт.
Каждый член Комиссии «Кодекс Алиментариус» несет ответственность за выявление и представление в соответствующий Комитет новой научной и иной значимой информации, которая может вызвать необходимость внесения изменений в какой-либо из существующих стандартов или родственных текстов Кодекса.
Все информация в системе Кодекса является открытой и бесплатной.
Чтобы узнать больше, ознакомьтесь с разделом «Часто задаваемые вопросы» на данном сайте (FAQ) или обратитесь по следующему адресу:
Секретариат Кодекса
Объединенная программа ФАО/ВОЗ по стандартам на пищевые продукты
Штаб-квартира ФАО
Viale delle Terme di Caracalla
00153 Rome, Italy
Тел. : (+39) 06 57051
Эл. адрес: [email protected]
На чаше весов – здоровье потребителей и добросовестная торговля продовольствием.
© FAO/WHO, 2023
Codex Определение и значение — Merriam-Webster
ко·декс ˈkō-ˌdeks
: рукописная книга, в частности Священного Писания, классических произведений или древних летописей
Знаете ли вы?
В 3-м и 4-м веках нашей эры кодекс начал заменять старый свиток как предпочтительную форму для более длинных текстов. В отличие от свитка, это замечательное изобретение позволяло писать на обеих сторонах листа, облегчало поиск определенного отрывка и могло содержать очень длинный текст. Кодексы (обратите внимание на эту необычную форму множественного числа) обычно писались на пергаменте, специально подготовленной коже овцы или козы, или на папирусе, предке бумаги. Поскольку кодексы были написаны от руки, копий любого отдельного кодекса было немного, а иногда и только одна копия. Сегодня мы больше не пишем наши книги от руки, но современная книга сохранила в основном ту же форму, что и первоначальные кодексы.
Примеры предложений
Недавние примеры в Интернете
Это потребовало дальнейшего изучения, поэтому Уильямс обратился к ученым из Электронной библиотеки ранних рукописей в Калифорнии и Университета Рочестера в Нью-Йорке, чтобы провести многоспектральное изображение страниц кодекса
Эти примеры предложений автоматически выбираются из различных онлайн-источников новостей, чтобы отразить текущее использование слова «кодекс».
Мнения, выраженные в примерах, не отражают точку зрения Merriam-Webster или ее редакторов. Отправьте нам отзыв.История слов
Этимология
Латинский — больше в коде
Первое известное использование
1661, в значении, определенном выше
Путешественник во времени
Первое известное использование кода было в 1661 г.
Другие слова того же года кодовое слово
кодекс
кодекс рескриптус
Посмотреть другие записи поблизости
Процитировать эту запись «Кодекс».
Ссылка на копию
Медицинское определение
Кодекс
существительное
ко·декс ˈkō-ˌdeks
: официальный или стандартный набор формул и описаний лекарственных средств.
Кодекс, аналогичный Британскому Фармацевтическому Кодексу
Дополнительная информация от Merriam-Webster о
кодексеНглиш: Перевод кодекса для испаноязычных Последнее обновление: — Обновлены примеры предложений
Подпишитесь на крупнейший словарь Америки и получите тысячи дополнительных определений и расширенный поиск без рекламы!
Merriam-Webster без сокращений
О Кодексе | CODEXALIMENTARIUS FAO-WHO
О Кодексе | CODEXALIMENTARIUS ФАО-ВОЗPage tools
CO D E X A L I M E N T A R I U S – это безопасная и полезная еда для всех и везде.
Международная торговля пищевыми продуктами существует уже тысячи лет, но до недавнего времени продукты питания в основном производились, продавались и потреблялись на месте. За последнее столетие количество продуктов питания, продаваемых на международном уровне, выросло в геометрической прогрессии, и сегодня количество и разнообразие продуктов питания, которые никогда раньше не были возможными, путешествуют по миру.
Международные стандарты на пищевые продукты
КОД ЕКС А Л И М Е Н Т А Р И Ю Международные стандарты на пищевые продукты, руководящие принципы и своды правил способствуют обеспечению безопасности, качества и справедливости в этой международной торговле пищевыми продуктами. Потребители могут быть уверены в безопасности и качестве продуктов питания, которые они покупают, а импортеры могут быть уверены, что заказанные ими продукты питания будут соответствовать их спецификациям.
Защита здоровья потребителей
Беспокойство общественности по поводу безопасности пищевых продуктов часто ставит Кодекс в центр глобальных дискуссий. Ветеринарные препараты, пестициды, пищевые добавки и загрязнители – вот некоторые из вопросов, обсуждаемых на заседаниях Кодекса. Стандарты Кодекса основаны на достоверных научных данных, предоставленных независимыми международными органами по оценке рисков или на специальных консультациях, организованных ФАО и ВОЗ.
Хотя стандарты Кодекса являются рекомендациями для добровольного применения членами, во многих случаях они служат основой для национального законодательства.
Устранение барьеров в торговле
Ссылка на стандарты безопасности пищевых продуктов Кодекса в Соглашении Всемирной торговой организации по санитарным и фитосанитарным мерам (Соглашение СФС) означает, что Кодекс имеет далеко идущие последствия для разрешения торговых споров. От членов ВТО, желающих применять более строгие меры безопасности пищевых продуктов, чем те, которые установлены Кодексом, может потребоваться научное обоснование этих мер.
С момента своего основания в 1963 году система Кодекса развивалась открытым, прозрачным и инклюзивным образом для решения возникающих задач. Международная торговля пищевыми продуктами – это отрасль с годовым оборотом в 2000 миллиардов долларов, в которой производятся, продаются и транспортируются миллиарды тонн продуктов питания.
Цель Кодекса Алиментариус
Кодекс Алиментариус представляет собой сборник международно принятых стандартов на пищевые продукты и связанных с ними текстов, представленных в единообразной форме. Эти стандарты на пищевые продукты и связанные с ними тексты направлены на защиту здоровья потребителей и обеспечение добросовестной практики в торговле пищевыми продуктами. Публикация Кодекса Алиментариус призвана направлять и способствовать разработке и установлению определений и требований к пищевым продуктам, чтобы помочь в их гармонизации и тем самым облегчить международную торговлю.
Сфера применения Кодекса Алиментариус
Кодекс Алиментариус включает стандарты для всех основных пищевых продуктов, обработанных, полуфабрикатов или сырых, предназначенных для продажи потребителю. Материалы для дальнейшей переработки в пищевые продукты должны быть включены в объеме, необходимом для достижения целей Codex Alimentarius, как они определены. Codex Alimentarius включает положения, касающиеся гигиены пищевых продуктов, пищевых добавок, остатков пестицидов и ветеринарных препаратов, загрязнителей, маркировки и оформления, методов анализа и отбора проб, а также контроля и сертификации при импорте и экспорте.
Характер стандартов Кодекса
Стандарты Кодекса и связанные с ними тексты не являются заменой или альтернативой национальному законодательству. Законы и административные процедуры каждой страны содержат положения, соблюдение которых необходимо.
Стандарты Кодекса и соответствующие тексты содержат требования к пищевым продуктам, направленные на обеспечение потребителя безопасными, полезными пищевыми продуктами, не содержащими фальсификации, правильно маркированными и представленными. Стандарт Кодекса для любого пищевого продукта или пищевых продуктов должен быть составлен в соответствии с Форматом стандартов Кодекса на товары и содержать, при необходимости, перечисленные в нем разделы.