Code Monkey home page Code Monkey logo

monotome's Introduction

monotome

i wanted to start a wiki so i made this

screenshot

Get Started

  • Clone this project
  • Open a terminal
  • Navigate to the cloned directory
  • Run python -m http.server 8900
  • Browse to localhost:8900 to use the wiki

Structure

Subjects are ordered into a simple directory structure which is mirrored by index.json.

You can fill index.json's subjects by hand if you want to avoid running a script. You can also run node monotome/bin/generate.js, which will update index.json for you.

This readme.md is the start page of your wiki and each readme.md within a subject folder is the overview page for that subject.

Inlined articles

Monotome supports a link syntax for inlining other monotome articles (i.e. plain markdown files) into a source article. This technique is commonly known as transclusion.

inlined-wiki

Any link <a> with an href referring to a local file & which has the anchor tag attribute download will be inlined into the document. That is, if one file has some content followed by <a href="example/first.md" download></a>, then the contents of example/first.md is inlined in place of the anchor tag, at the position of the tag definition.

Backlinks

Monotome keeps track of backlinks, or incoming links from one article inside monotome to another. To discover backlinks, run node monotome/bin/generate.js. For a taste of what backlinks look like in practice, see the gif below.

monotome backlinks

License

monotome's code and resources are licensed under AGPL.

marked.js is MIT-licensed and Inter UI is available under SIL OPEN FONT LICENSE Version 1.1

Read the respective license files for more information.

monotome's People

Contributors

cblgh avatar corporate-brick avatar dmarto avatar timgoeller 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.