vimwiki

beau's personal wiki, made using vim
git clone https://git.beauhilton.com/vimwiki.git
Log | Files | Refs | README

vimwiki_in_git.md (1756B)


      1 # vimwiki_in_git
      2 :git:vimwiki:
      3 
      4 # Setup
      5 It took a bit of work to get this working, but I think we're there now. EDIT: I abandoned the .wiki version in favor of vanilla .git . It's much easier, and I can use folders.
      6 
      7 Steps to reproduce:
      8 
      9 - Make a new repo (this is probably optional, could have just used my "life" repo, but repos are free. :)
     10 - Get GitHub Pro with my student ID (wiki's are a Pro-only feature)
     11 - Navigate to the "wiki" tab on the website
     12 - Click into any of the pages, then "clone this wiki locally" (will have a link something like https://github.com/cbeauhilton/vimwiki.wiki.git - I converted this to an SSH format so I could use my key: git@github.com:/cbeauhilton/vimwiki.wiki.git )
     13 - Git clone git@github.com:/cbeauhilton/vimwiki.wiki.git
     14 - Either start writing from here, or copy in the old vimwiki contents (e.g. cp -a vimwiki/. vimwiki.wiki/ )
     15 - Git add/commit/push
     16 - Check it out on GitHub!
     17 
     18 The tutorial found here is very good, and I used most of its steps, subbing in GitHub for GitLab: https://opensource.com/article/18/6/vimwiki-gitlab-notes
     19 
     20 # Organization
     21 I tried to put things into folders to make the directory cleaner, but that borked the compatibility with GitHub (it could probably be worked out, but...). It seems that the best way to keep this organized and compatible with GH is to keep the structure flat, then make the index.md collapsible and well organized visually. On GH, the "pages" page will be essentially useless, but accessing the index will show a pretty and well-organized page. If I decide to sidestep GH at some point, I could pretty easily go back to folders.
     22 
     23 EDIT: Using the .wiki style ended up being a pain, and the links in a normal GitHub repo work just fine.
     24 Sun 17 Nov 2019 10:23:05 AM CST