Coder Social home page Coder Social logo

tachytaenius / bibliopotamia Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 0.0 6 KB

(Requires python-markdown2.) A workflow setup for writing that uses python and markdown (license overkill included)

License: GNU Lesser General Public License v3.0

Python 100.00%

bibliopotamia's Introduction

What is this?

Bibliopotamia (approximately Greek for "book river" or "document stream") is a workflow setup that uses python and markdown to allow for separate *.md chapters and a simple way to combine them. Down with nonfree editors with their bloated formats that force others to use said editors! Rise, whichever text editor you wish to use! And if you want your markdown documents to come out in HTML... then rise, Bibliopotamia!!

How does it work?

Individual markdown chapters are linked and ordered by the user in the file "../chapters.txt," ((bibliopotamia is meant to be added to book setups as a submodule, which is a subdirectory. So the work itself will be in bibliopotamia's superdirectory) it's just writing the name of the chapters's file, adding a new line and repeating. Having a trailing newline is safe if you're into that) then a script called "compile.py" is executed. The script concatenates each chapter as directed by the chapters list, separating them using some newlines with a horizontal rule. The resulting string is then converted by markdown2 into an output HTML file, which is then saved where the user wishes (overwite prompt included!)

How do I use it?

Write your *.md files, one for each chapter to be separated by a horizontal rule. Set your working directory to bibliopotamia, which should be a subdirectory to where your *.md files are. Run compile.py with python, and tell the program where you want to output your HTML file.

As for chapters.txt, remember that it goes in the directory above compile.py (because this is meant to be added as a submodule or just a subdirectory if you're not using git,) along with the chapter files themselves. 00_Title.md will be concatenated with 01_InTheBeginning.md, which will be concatenated to 02_HappilyEverAfter.md, with a horizontal rule between each.

00_Title.md
01_InTheBeginning.md
02_HappilyEverAfter.md

bibliopotamia's People

Contributors

tachytaenius 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.