Ok. Maybe this is a good idea.
Problem: You want your students to keep track of their research in an open notebook. You don’t want to faff with jekyll and anything too complicated. You don’t know what kinds of machines your students will have, so it’s got to be cross-platform.
Perhaps a solution:
- Student creates a new folder on their machine called ‘open notebook’.
- Student downloads MDWiki (download link)
- Student unzips the mdwiki.html file into their ‘open notebook’ folder.
- Student renames mdwiki.html to index.html
- Student saves all notes as markdown text files in that folder, with the .md file extension, using a text editor. I will suggest Atom for reasons below.
- Student pushes that entire folder as a new repo on gh pages at github, or moves it onto a server somewhere else.
- Student opens the site in their browser. If there was a note in there called ‘Sept-19.md’, that can be seen by going to http://example.com/Sept-19.md, rendered in lovely html 5.
Ta da! A completely client-side website, built from the student’s notes. As the bumpf says,
mdwiki.htmlshipped with MDwiki into the same directory as your markdown files and you are good to go!
- In atom, go to atom >preferences > install, and search for the nvatom package.
- Install the package
- In atom, go to atom > config and add this to the bottom of the file:
nvatom: directory: "/path/to/student/opennotebook/"
and then save the config file.
Now, when the student has one of the note files open in Atom, she can hit alt-cmd-l to search through all the notes quickly just as one would with Notational Velocity (so the search window searches inside the file as well). The student can then click on the file name and have that file card open. To link between files, the student simply has to write the file name without the extension, between square brackets like so:
[[Plato's conception of the just]]
The student can then click on that link and hit alt-cmd-o to open that file henceforth. To make sure that the link can be understood by MDWiki, we do one last thing:
[[Plato's conception of the just]](Plato's conception of the just.md)
The link now works both within Atom and on the website.
Finally, to create a master list of all notes, the student can open the notebook folder at the terminal, and type
ls > all.md
Then open that list in Atom, add [[ ]] and ( ) as appropriate. Then, in the browser, once you’ve moved your changes online, you just have to go to the all.md file to see everything at once.
This is a helluva lot easier that fighting with Jekyll all day.