Looking for documentation system

Levi

Looking for ultra-lightweight documentation/wiki system. Maybe there is a plain text one (no DB required)? For documenting my own projects.

SpeedBus

Dokuwiki is quite solid, no db required either.

perennate

I don't think a documentation system that doesn't use an existing database is going to be lightweight -- it's going to need to implement something to deal with text files and potential consistency issues.

Probably you want something that uses a lightweight database like sqlite. Or just use git or google drive.

WSS

vi

iqbal

google keep note? evernote?

seriesn

I have been searching for something like this for ages : https://docs.mongodb.com/

kaz050457

https://vuepress.vuejs.org/

hzr

seriesn said: I have been searching for something like this for ages : https://docs.mongodb.com/

https://github.com/mongodb/snooty

https://github.com/mongodb/docs-tools

bsdguy

@WSS said:
vi

acme!

(gawd, are you one handsome guy)

MikeA

I recently setup Bookstack to convert many of my old text docs to something that can be held remotely and better formatted. I like it.

Kiwi83

http://raneto.com/

SGraf

@SpeedBus said:
Dokuwiki is quite solid, no db required either.

+1 on dokuwiki

jetchirag

@MikeA said:
I recently setup Bookstack to convert many of my old text docs to something that can be held remotely and better formatted. I like it.

+1 for Bookstack

jetchirag

@seriesn said:
I have been searching for something like this for ages : https://docs.mongodb.com/

If cloud based is fine, https://archbee.io/team-wiki is running a lifetime deal. I don't know how much they compare to this tho.

yokowasis

what's wrong with good old README.md

seriesn

@jetchirag said:

@seriesn said:
I have been searching for something like this for ages : https://docs.mongodb.com/

If cloud based is fine, https://archbee.io/team-wiki is running a lifetime deal. I don't know how much they compare to this tho.

Need something local and internal to be honest. Can't afford the things to go kapoot you know.

Levi

@yokowasis said:
what's wrong with good old README.md

Absolutely nothing as well as simple.txt but Ineed something more structured.i will try dokuwiki, it looks good and standard. Thank you.

WSS

vim

LightBlade

Markdown and without database ofc
https://docusaurus.io/

Clouvider

Atlassian

Host4Geeks

bookstackapp.com

Self-Hosted, LAMP Stack.

dz_paji

@kaz050457 said:
https://vuepress.vuejs.org/

+1 for vuepress as well. Supports markdown and easy to use. Because it just gives static pages, it's pretty "lightweight" I believe.

Levi

Dokuwiki is perfect. Style and speed are good. Running from my rPi 2 without a problem.

Unixfy

Clouvider said: Atlassian

+1. Not (really) lightweight but it does the job better than anything else I've tried.

jsg

@perennate said:
I don't think a documentation system that doesn't use an existing database is going to be lightweight -- it's going to need to implement something to deal with text files and potential consistency issues.

Probably you want something that uses a lightweight database like sqlite. Or just use git or google drive.

I disagree. First issue: why SQL at all? Plus most wikis are simply structured (from a developers POV) and don't have hundreds of thousands of entries.

@LTniger

A bit more information would be useful in order to get sensible advice/suggestions

seriesn

Chose to use Hesk with private kb. Granted, uses SQL but pretty simple and gets the job done. Plus creates an internal helpdesk for "team"

perennate

jsg said: I disagree. First issue: why SQL at all? Plus most wikis are simply structured (from a developers POV) and don't have hundreds of thousands of entries.

I was thinking OP wanted a web app where they could edit the documentation from the web app, in which case I'd argue a system that uses a database like sqlite is going to be lighter weight than one that deals with the potential concurrency / consistency issues itself.

But otherwise I think some text files in git or a google drive shared folder would be fine solutions. Or if they do want to view the documentation in a web app, but not necessarily edit it from there, then one of the static site generator.

Agreed they need to give more info.

Edit: see e.g. https://www.dokuwiki.org/devel:locking

Jord

Thanks @MikeA BookStack looks gut sir.

bsdguy

@WSS said:
vim

Is there a browser plugin version? And I do not mean some w3m extension because something not gobbling up min. 1 GB RAM is neither a modern browser nor a modern editor.

Anyway I'm more interested in how you maintain and nurture your super-beautiful hair.

jsg

@perennate said:
I was thinking OP wanted a web app where they could edit the documentation from the web app, in which case I'd argue a system that uses a database like sqlite is going to be lighter weight than one that deals with the potential concurrency / consistency issues itself.

But otherwise I think some text files in git or a google drive shared folder would be fine solutions. Or if they do want to view the documentation in a web app, but not necessarily edit it from there, then one of the static site generator.

Agreed they need to give more info.

Edit: see e.g. https://www.dokuwiki.org/devel:locking

OK but for simple jobs like a lite wiki using a DB without SQL is fine and even lighter. Depending on the job even directory structure plus a simple small index updater might be good enough.