Can you create it as a wiki instead of repo #41
Comments
|
If the list expands further I think we will have to, at some point. Initially I wanted to keep it all on one page for easy browser searching. Right now I'm planning to create a GitHub page with a sidebar navigation. See issue #7 |
|
we can even keep it on 1 wiki page and have sidebar with anchor tags.... |
|
I say we keep it as a single markdown file and then use a javascript markdown parser (this one?) to render the page for web viewing. Having it all in a single markdown file makes it easy for reading in plain text and doing plain text search. Plus I dig the novelty of it. |
|
Proof of concept. Uses three files ./lib/markdown.js: markdown->HTML README.html <!doctype html>
<html>
<body>
<div id="preview"> </div>
<script src="lib/markdown.js"></script>
<script>
/**
* Some browsers might complain about cross-origin requests if you try
* opening this directly in your browser. Instead, you have to launch
* a HTTP server. Open a terminal/command prompt in this directory and
* use one of commands listed below.
*
* The file can then be accessed from http://localhost:8000/readme.html
*
* # Python 2.x
* python -m SimpleHTTPServer
*
* # Python 3.x
* python -m http.server
*
* # PHP 5.4+
* php -S localhost:8000
*
* # NodeJS
* npm install http-server -g
* http-server .
*
* # Ruby
* ruby -r webrick -e "s = WEBrick::HTTPServer.new(:Port => 8000, :DocumentRoot => Dir.pwd); trap('INT') { s.shutdown }; s.start"
*
* Source: https://github.com/mrdoob/three.js/wiki/How-to-run-things-locally
*/
var preview = document.getElementById('preview');
xhr = new XMLHttpRequest();
xhr.open("GET",'README.md',false);
xhr.send(null);
preview.innerHTML = markdown.toHTML( xhr.responseText );
</script>
</body>
</html> |
|
I decided to keep the structure of the document as is for now. |
If we have it as wiki pages... then we can have a sidebar... and we easily move.
example:
https://github.com/harrah/xsbt/wiki/Examples
Or we can have table of content on the top of current page.
The text was updated successfully, but these errors were encountered: