Raneto icon indicating copy to clipboard operation
Raneto copied to clipboard

Markdown powered Knowledgebase Wiki for Node.js

Raneto CircleCI

Raneto Logo

Raneto is a free, open, simple Markdown powered knowledge base for Node.js. Find out more →

Important Updates

  • Please ensure you're on Raneto v0.17.1 for the latest security fixes
  • Join the Roadmap Discussion

Demo

Visit https://docs.raneto.com to see a demo and get started!

Quickstart

  1. In a terminal, run:
    git clone https://github.com/ryanlelek/Raneto.git
    cd Raneto
    npm install && npm run gulp && npm start
    
  2. Visit http://localhost:3000 to display the output.

See the installation guide for more information.

Supported Node Versions:

  • v18.x.x (Current)
  • v16.x.x (LTS)

Please use the latest version available of the above major Node.js releases to ensure you have the latest security fixes!

Security

Make sure you edit the default username and password in your config.js file.

##### WARNING #####
// You MUST change the username and password for security
// Do NOT use "admin" as a username as it's easily guessed.
// You are encouraged to use tools to generate a password
// Preferably, use a local password manager
// If you absolutely must use an online tool, here are some suggestions
// https://bitwarden.com/password-generator/
// https://www.grc.com/passwords.htm

Markdown Reference

If you want to embed links and images, you'll need to use the Markdown syntax.
See this Markdown Guide

Links

Showcase

Are you using Raneto in the wild? We'd love to see it. Please add it to this list:

Related Projects

Credits