https://github.com/raehik/jekyll-wiki-template

A template for a personal wiki using Jekyll.
https://github.com/raehik/jekyll-wiki-template

Last synced: about 2 months ago
JSON representation

A template for a personal wiki using Jekyll.

• Host: GitHub
• URL: https://github.com/raehik/jekyll-wiki-template
• Owner: raehik
• License: mit
• Created: 2015-04-07T15:30:31.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2016-02-29T11:45:11.000Z (almost 9 years ago)
• Last Synced: 2024-06-11T18:31:50.861Z (7 months ago)
• Language: Ruby
• Size: 14.6 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Jekyll wiki template

====================

A Jekyll site template that makes it easier to develop a static [personal

wiki](https://en.wikipedia.org/wiki/Personal_wiki).

Why a personal wiki?

--------------------

I'm bad at remembering things. Worse, when I have lots of things to

remember, keeping them in my mind saps my concentration. Knowing this, I

occasionally write post-it notes or make small text files. But the

contents can be varied (I might want to write down some notes for a

game, or how to solve a common computer problem), and I didn't have a

central place to hold all those memos.

Enter the wiki. You can put all types of information and knowledge into

a central place and easily recall anything in it. My wiki template also

does lots of other useful things such as shortening common syntax (e.g.

linking to other wiki pages), generating a table of contents for each

page, and making frontmatter optional.

Usage

-----

Getting started with a new wiki is simple. Just clone the repo:

    git clone https://github.com/raehik/jekyll-wiki-template 

    cd 

Delete the .git directory:

    rm -rf .git

And you're good to go! You'll probably want to create a new Git

repository:

    git init

Now you're all set up with a new wiki in an empty repo.

License

-------

All code is made available under the MIT license (see `LICENSE`).

TODO

----

  * Talk about how it can be used

  * Expects a favicon at `favicon.png`