Code Monkey home page Code Monkey logo

bemis's Introduction

Bemis

All the docs you could ever want! All the docs you could ever need!

Bemis is a mod for writing documentation. It’s explicitly intended as a competitor to Patchouli.

Why use Bemis?

  • Books are written in AsciiDoc, not JSON, and laid out like your files are laid out on disk. Stop writing text in a format designed for data, and start writing it in a real markup language!

  • First-class export to HTML, out of the box.

  • Extensible for developers. Easily add your own page elements and load them seamlessly.

For Developers

Remember ABC:

  • Asciidoc. Bemis will find all the .adoc files, process their ASTs, and compose them into an index of pages. You can write AsciiDoctor-style preprocessors here too.

  • Bemis. Bemis turns the Asciidoc AST nodes into a flat list of "verses." It comes with a set of pre-defined AST β†’ verse converters. You can also write and register your own. This is the part where things like crafting recipe displays are created.

  • Client. Then, the client reads the docs. In-game, this is where verses get rendered to the screen. Or, they can read it in an HTML export.

bemis's People

Contributors

darkhax avatar jaredlll08 avatar gamma-delta avatar witixin1512 avatar aegide avatar hubry avatar algorithmlx avatar lukebemish 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.