Code Monkey home page Code Monkey logo

website_generator's Introduction

website generator

build tests linters

Описание программы

Простой статический генератор сайтов.

Программа принимает на вход два пути к директориям. Первую директорию будем называть входной директорией, а вторую — выходной.

Генератор обходит все файлы и поддиректории входной директории и выполнить для них следующее:

Для каждой поддиректории входной директории создается соответствующая ей поддиректория в выходной директории. Каждый файл с расширением .gmi из входной директории транслируется в соответствующий .html файл в выходной директории. Трансляция осуществляться в соответствии с форматом разметки gemtext. Каждый файл с расширением отличным от .gmi из входной директории копируется в соответствующее ему место выходной директории или ее поддиректорий.

Основной алгоритм программы

Благодаря простоте формата gemtext, парсить файл можно построчно. Таким образом, входной поток разбирается строка за строкой. Каждая строка gemtext однозначно преобразуется в строку html благодаря наличию префикса, обозначающего тип строки. Однако, необходимо учитывать необходимость отслеживать два возможных состояния:

  • Состояние обработки элементов списка (Для правильной генерации <ul></ul>).
  • Состояние обработки преформатированного текста.

Отслеживание этих состояний можно организовать в виде двух логических переменных и переключать их в зависимости от входной строки из потока.

Структура программы

Для создания программы была создана библиотека с набором классов. Классы типа транслятор переводят входной поток из одного формата в другой. Клас типа поисковика в файловой структуре позволяет найти все необходимые файлы. Классы генераторы должны преобразовывать файлы входной директории в файлы выходной, используя трансляторы и поисковики. Каждый из этих типов классов поставляет соответствующий задачам класса интерфейс, а саму логику реализуют уже конкретные классы. Так, для поставленной задачи используется генератор GemtextGenerator.

Более подробно со структурой программы можно ознакомиться в директории doc, там представленая uml диаграмма классов библиотеки.

Стуктура файлов

В данном репозитории находится несколько директорий.

  • doc - справочная информация
  • tools - вспомогательные скрипты
  • project - исходники проекта
  • tests - тесты

website_generator's People

Contributors

dunaitseva avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.