🌜
🌞
raneto

raneto

v0.17.0

Markdown powered Knowledgebase

npm install raneto

README

Raneto

Raneto Logo

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

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

Quickstart

  1. In a terminal, run:

    git clone https://github.com/gilbitron/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:

  • v14.x.x (Current)
  • v12.x.x (LTS)
  • v10.x.x (LTS) Please use the latest version available of the above major Node.js releases to ensure you have the latest security fixes!

Credits

Raneto was created by Gilbert Pellegrom from Dev7studios. Maintained by Ryan Lelek from AnsibleTutorials.com. Logo by @mmamrila Released under the MIT license.

Release Notes

0.17.0
By Ryan Lelek • Published on March 28, 2021

2021.03.28 / v0.17.0

Possible breaking changes, based on your implementation

  • [Edit] Listening on 127.0.0.1 instead of all interfaces #345

Fully up to date modules as of 2020-03-28

-- Ryan

0.16.6
By Ryan Lelek • Published on February 4, 2021

2021.02.04 / v0.16.6

  • [Fix] Example configuration file #338
    • contributed by @ryanlelek

Fully up to date modules as of 2020-02-04

-- Ryan

0.16.5
By Ryan Lelek • Published on December 25, 2020

2020.12.25 / v0.16.5

  • [New] Swedish translation

    • contributed by @Synt3x
  • [New] Japanese translation

    • contributed by @filunK
  • [New] Add table of contents

    • contributed by @benruehl
  • [New] Added side menu collapsing functionality

    • contributed by @philipstratford
  • [New] Visibility of menu on pages toggle

    • contributed by @philipstratford
  • [New] Google groups restriction

    • contributed by @Axadiw
  • [New] Category meta description

    • contributed by @marcello.gorla
  • [Doc] TOC and site menu on pages

    • contributed by @philipstratford
  • [Doc] Updated install, guide, and README pages

    • contributed by @Arthur Flageul
  • [Fix] Fixed bug highlighting of second-level page titles

    • contributed by @philipstratford
  • [Fix] #189 base_url config

    • contributed by @ryanlelek
  • [Fix] Side menu visibility

    • contributed by @Synt3x
  • [Fix] lunr-languages/tinyseg instead of tiny-segmenter

    • contributed by @filunK
  • [Fix] Travis, Yarn, NPM, etc.

    • contributed by @filunK
  • [Fix] wrong fitvids js location

    • contributed by @jrichardsz

Fully up to date modules as of 2020-12-25

-- Ryan

0.16.4
By Ryan Lelek • Published on August 11, 2019

2019.08.11 / v0.16.4

  • [New] Async IO Improvements #294
    • contributed by @pmoleri
  • [New] Danish Translation #292
    • contributed by @MortenHC
  • [Fixed] Heroku postinstall script #291
    • contributed by @shamork
  • [Fixed] Code fixes for upgraded dependencies
    • contributed by @ryanlelek
  • [Misc] Dependency upgrades

We are once again fully up-to-date on NPM modules

-- Ryan

0.16.2
By Ryan Lelek • Published on January 19, 2019

2019.01.19 / v0.16.2

  • [New] Polish Translation
    • contributed by @suprovsky - Radosław Serba
  • [Fixed] base_url ignored on login page #200
    • contributed by @GrahamDumpleton
  • [Fixed] Request for translations.json doesn't include base_url #279
    • contributed by @GrahamDumpleton
  • [Fixed] Proxy subfolders #189
    • contributed by @GrahamDumpleton
  • [Misc] Dependency upgrades
0.16.0
By Ryan Lelek • Published on April 21, 2018

2018.04.21 / v0.16.0

  • [New] Better Multi-Language Support!
    • contributed by @Orhideous
  • [New] Raneto can be served from non-root path (URI Prefix)
    • contributed by @gugu
  • [Misc] Upgrade to lunr v2.x
    • contributed by @Orhideous
  • [Misc] Code Refactor
    • contributed by @Orhideous
  • [Misc] Dependency upgrades
0.15.0
By Ryan Lelek • Published on March 30, 2018

2018.03.29 / v0.15.0

  • [New] Language Translations!
    • Romanian contributed by @mariuspana
  • [Fixed] #192 Any metadata will now cause metadata to render
    • @mralexgray
  • [Fixed] Login page loading of jQuery Backstretch plugin
    • @Zezzty
  • [Fixed] #247 Search result page no longer shows excerpt as link text
    • @Zezzty
  • [Fixed] #251 #194 Documentation in README for local install
    • @shui
  • [Misc] Dependency upgrades
0.14.0
By Ryan Lelek • Published on January 10, 2018

2018.01.09 / v0.14.0

  • [New] Language Translations!
    • Spanish contributed by @dgarcia202
    • Norwegian contributed by @kek91
    • Hungarian contributed by @gabord
  • [New] Multi-level Page Nesting
    • @denisvmedia
  • [New] Marking Active Category in UI
    • @pmoleri
  • [New] Export of Raneto class
    • @pmoleri
  • [Improvement] Search with Special Characters
    • @cassiobsilva
  • [Improvement] Upgrade to SweetAlert2
    • @limonte
  • [Misc] Remove Babel
    • @pmoleri
  • [Misc] Move from JSHint to ESLint
    • @Sparticuz
  • [Misc] Code Refinements
    • @furier
    • @dettoni
    • @denisvmedia
    • @dgarcia202
  • [Misc] Document Refinements
    • @dgarcia202
    • @n7st
  • [Misc] Dependency upgrades
0.13.0
By Ryan Lelek • Published on March 15, 2017

2017.03.15 / v0.13.0

  • [New] Nested Pages
    • contributed by @zmateusz
  • [New] Manual Category Title
    • contributed by @theRealWardo
  • [New] Last Edited Metadata Header
    • contributed by @Sparticuz
  • [New] Require Authentication for Viewing
    • contributed by @bschne and @mohammadrafigh
  • [Improvement] Meta Data RegEx Refinement
    • contributed by @cmeyer90
  • [Improvement] Unix Sitemap Generation
    • contributed by @forsureitsme
  • [Improvement] Display All Files Fix
    • contributed by @forsureitsme
  • [Misc] Code Refinements
    • @shyim
    • @Sparticuz
    • @theRealWardo
  • [Misc] Dependency upgrades
0.11.0
By Ryan Lelek • Published on September 14, 2016

2016.09.13 / v0.11.0

  • [New] Language Translations!
    • Mandarin Chinese contributed by @noahvans
    • French contributed by @sfoubert
    • Brazilian Portuguese contributed by @ToasterBR
  • [New] Google OAuth Support
    • contributed by @Hitman666
  • [New] Authentication for Edit (Public Read-Only)
    • contributed by @alexspeller
  • [New] Dynamic Sitemap.xml
    • contributed by @sfoubert
  • [New] Custom Variables
    • contributed by @Sparticuz
  • [Improvement] Multiple User Login
    • contributed by @mohammadrafigh
  • [Improvement] Table of Contents (Dynamic)
    • contributed by @Sparticuz
  • [Misc] Merged Raneto-Core module into repository
  • [Misc] Dependency upgrades

General

License
MIT
Typescript Types
None found
Tree-shakeable
No

Popularity

GitHub Stargazers
2,530
Community Interest
3,007
Number of Forks
455

Maintenance

Commits
11/2110/22035
Last Commit
Open Issues
74
Closed Issues
155
Open Pull Requests
1
Closed Pull Requests
28

Versions

Versions Released
11/2110/2201
Latest Version Released
Mar 28, 2021
Current Tags
latest0.17.0

Contributors

ryanlelek
ryanlelek
Commits: 181
gilbitron
gilbitron
Commits: 42
Sparticuz
Sparticuz
Commits: 21
Radiergummi
Radiergummi
Commits: 17
filunK
filunK
Commits: 11
pmoleri
pmoleri
Commits: 8
draptik
draptik
Commits: 8
Orhideous
Orhideous
Commits: 8
dgarcia202
dgarcia202
Commits: 7
Hitman666
Hitman666
Commits: 7
matthiassb
matthiassb
Commits: 6
GrahamDumpleton
GrahamDumpleton
Commits: 6
mohammadrafigh
mohammadrafigh
Commits: 4
philipstratford
philipstratford
Commits: 3
cmeyer90
cmeyer90
Commits: 3