Code Monkey home page Code Monkey logo

raito's Introduction

Raito | Mini Markdown CMS โœจ๐Ÿ“

Build your website with a single file!

Raito is an ultralight static CMS/Wiki that weights 8kb.
Hence the name, ใƒฉใ‚คใƒˆ meaning light in Japanese.

Made by Arnaud de Saint Meloir, inspired by the defunct MDwiki

Check the Demo ๐Ÿ”ฅ

Install

Just drop index.html in your website root.

Usage

Place Markdown files in the directory. Folders redirect to README.md.

Most modern Markdown components are supported, check the examples.

Relative links

All links to local markdown files should be relative (not starting with /).
Directory links (ending with /) will display the root README.md.

Customisation

Edit the config variable in index.html.

Subdirectory install

To install Raito in a subdirectory, just specify the folder relative to root in config.root in index.html. Check out the branch subdir-example for a working example at http://localhost:8000/subdir_example/

Syntax Highlighting

Uncomment the highlight.js imports in index.html. This adds significant bundle size.

Components

Components are visible in every page, and useful for navbars, sidebars and footers.

Create your component in a .md file, then add it to config.json.

Chart.js

Chart.js support is not official yet, but check out this setup example.

Development

Run locally

Run a local HTTP server, and access http://localhost:8000

docker-compose up
# OR
python -m http.server 8000

Dependencies

Todolist

  • Subdir Support
  • Dark mode
  • Fix history navigation

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.