https://github.com/lotabout/static-wiki

https://github.com/lotabout/static-wiki

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/lotabout/static-wiki
• Owner: lotabout
• License: mit
• Created: 2016-02-18T10:30:05.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2023-08-11T04:19:21.000Z (over 1 year ago)
• Last Synced: 2024-11-05T08:36:57.065Z (4 months ago)
• Language: CSS
• Size: 28.3 KB
• Stars: 16
• Watchers: 3
• Forks: 6
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[Demo Page](http://lotabout.me/static-wiki/)

# static-wiki

Static wiki is a client side wiki for pure markdown. All you need is a simple file

server(Github Pages is enough) to serve files and a browser to actually view.

1. Now you can write your documents in markdown and never have to worry about it

   anymore.

2. If you use Github Pages, you can turn github into your own personal wiki

   with some simple configurations.

## Installation

1. copy `index.html`, `css/`, `main.js` into your wiki directory.

2. Create file `index.md` if not exist. This will be your home page.

3. Start a file server under your wiki directory.

How to start a file server? Take

[http-server](https://www.npmjs.com/package/http-server) as an example:

```

npm install -g http-server

cd your-wiki-directory

http-server

```

## Configuration

**Change Default Home Page**:

1. open `main.js` with your favorite editor.

2. change `index.md` in `var file_index = 'index.md';` to whatever you like.

**Search**

In order to provide search function, `static-wiki` will actually download

every markdown file behind the scene. However, `static-wiki` have no idea what

files are contained in your wiki, so you need to add file `all.txt` in your

wiki with all the markdown file names(line by line) like:

```

index.md

README.md

```

**Further Configuration**

Well, it is written in HTML/CSS/Javascript, modify as you wish.

## Use Github Pages for Hosting

[Github Pages](https://pages.github.com/) provide hosts of static file for

project wikis. Which in our case is the perfect tool for serving files. I

won't go into the details of using Github pages, please read the corresponding

documents.

Here is my workflow.

1. Publish my wiki(markdown files and static-wiki files) to branch `gh-pages`

   to enable Github pages. Now our wiki is up.

2. Whenever I want to edit something, I directly edit it on Github, Done.