Code Monkey home page Code Monkey logo

docfs's Introduction

Docfs

Docfs is a file service, which translates pdf and epub documents into Altid-flavored markup.

go install github.com/altid/docfs

Usage

docfs [-p <dir>]

  • will default to /tmp/altid/docs if none is provided.

Configuration

# altid/config - Place this in your operating systems' default configuration directory
service=docs
	log=/usr/halfwit/log
	#listen_address=192.168.0.4
  • log is a location to store the body of markdown from parsed documents. A special value of none disables logging.
  • listen_address is a more advanced topic, explained here: Using listen_address

See altid configuration for more information

PDF

Currently, pdfs are unsupported. You can toy around with opening them, and will see some structural elements such as a ToC and a title; but the main body parsing is incomplete.

Epub

Currently, epubs are in an alpha state of support. They are fully converted to Altid-compatible directory structures, but there may be elements which are missing, incorrectly formatted, or invalid when read by particular clients.

EPUB3 are currently not supported. Any help here is greatly appreciated!

docfs's People

Contributors

halfwit avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar

Forkers

frankfanslc

docfs's Issues

Anchor links

v0.0.1 add anchors to link sidebar items to the main document

Output is still full of html elements

Currently, many <span> and <div> elements still remain in the markdown; we'll have to update ubqt-client to either understand these or outright ignore them.

Parse assets

v0.0.1 set up logdir/resources/images/mydoc.pdf/, and link that to our local mydoc.pdf/images/

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.