Skip to content

A simple offline Wiki using Chromium and Markdown Viewer.

Notifications You must be signed in to change notification settings

materye/poormanswiki

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Poor man's Wiki (Linux, Windows, Mac)

A simple offline Wiki using Chromium and Markdown Viewer.

-screenshot

Features

  • Work offline
  • Manage your Wiki using Markdown
  • Get a nice overview of all your files
  • Use Fuzzysearch to find what you need
  • Only requires Chromium, Markdown Viewer and Bash or Powershell
  • May also work with Firefox + Markdown Viewer (not tested)

Project

.
├── images                          (store your images here)
├── webs
│   ├── favicon.png                 (required, icon shown in browser)
│   ├── htmlpreview.min.js          (required)
│   ├── jquery-1.11.3.js            (required)
│   ├── radar.css                   (required, copied from markdown viewer)
│   ├── style.css                   (required, modifications)
│   └── wikis.js                    (required, created by wiki-update.sh)
├── wikis                           (store your wiki entries here)
│   └── wiki-update.sh              (required, run after adding new file)
├── index.html                      (required, start page)
└── README.md

Setting up Chromium

  • Install Markdown Viewer for chromium/chrome
  • Go to chrome://extensions/ and enable "Allow access to file URLs"

Setting up Poor man's Wiki

  • Download the Repo
  • Run the script:
    • Linux/Mac: wiki-update.sh
    • Windows: wiki-update.ps1
  • Open index.html in your browser

Workflow

  • Create/Add a new markdown file and run the script
  • Refresh your browser

Sources

I pretty much did nothing it's all just copy and paste.

About

A simple offline Wiki using Chromium and Markdown Viewer.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published