This is a project to build a static documentation website for Couchbase. After checking out a variety of static frameworks, we settled on Punch, in NodeJS.
- Something better than Google Custom search or alternate page separatation/anchors, especially for jump-links. (Marty - investigating)
- Add corporate website headers, footers, etc to docs initial landing page (Karen)
- Improve left navigation. Items at end disappear when multiple sub-menus are open. (Volker - DONE)
- Short-term mobile hack -toggle open and close of left navigation to support mobile. (Volker)
- Longer term mobile layout.
- Input/improvements popout hooked up to CBugg (Dustin)
- Parser/conversions from SDK comments to Markdown (Sergey Ruby and C)
- Anything else you can think of to make this a great user and authoring experience.
- Make repo public, or at minimum add support as contributors.
- Provide longer pages with jump links to subsections
- Fork it and clone (
git clone [email protected]:USERNAME/punch_stuff.git) - Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request
- Make sure you have
npminstalled on your node.js - Install punch (
sudo npm install -g punch) - Start punch server (
punch server) - Go to http://localhost:9009/
- For general content, be aware of this site structure:
|-contents |---_archives |---_dev_guide |---_index |---_java |---_ruby |---_ruby11 |---_server_guide
At this level, the latest, current major point version of the doc exists. For earlier versions, create a subfolder underneath the guide, for instance _ruby11.
-
For images, Punch requires that they be in templates/images. So use a subfolder in the directory that corresponds to your guide.
-
Experimental features/Labs, other items that have not yet been released:
-
For your first paragraph, add the class .labs:
<p class="lab"></p> -
Add the text to the paragraph:
"{Description of your feature here, what someone can use it for, benefits of this feature, potential use cases for the feature.} Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. This feature is experimental and is not meant for use in production systems. Be aware that you are using it at your own risk. We expect to release the final version of this feature in X.X of Y."
-