tree: 3200e9241f227dfdf35a6acb63117c2aa8eb7ef5 [path history] [tgz]
  1. .nojekyll
  2. README.md
  3. __common.soy
  4. buck.css
  5. command/
  6. concept/
  7. contributing/
  8. extending/
  9. favicon.png
  10. fork_me.png
  11. function/
  12. globals.json
  13. google-code-prettify/
  14. index.soy
  15. plovr-81ed862.jar
  16. publish.sh
  17. rule/
  18. setup/
  19. soy2html.py
  20. soy2html.sh
  21. soyweb.sh
docs/README.md

This directory contains the templates for Buck's HTML documentation, as well as the scripts to publish said documentation.

Editing Documentation

Buck documentation is written using Closure Templates. Documentation can be developed locally by running the following command:

./docs/soyweb.sh

and then navigating to http://localhost:9811/ in the browser. The typical edit/refresh style of web development applies for editing these docs. Ideally, changes to Buck code will include updates to these docs in the same commit so that the relationship between the code and documentation changes is clear.

Note that the edit/refresh cycle of local documentation development is made possible via plovr.

Publishing Documentation

This documentation is hosted publicly at http://facebook.github.com/buck/ using GitHub Pages. Therefore, to publish this documentation, you must commit it on the gh-pages branch of the GitHub repository by running:

./docs/publish.sh

Creating a New Article

Create a file and seed it with the following content:

{namespace buck.ADD_YOUR_PAGE_NAME}

/***/
{template .soyweb}
  {call buck.page}
    {param title: 'ADD_YOUR_TITLE' /}
    {param content}

ADD_YOUR_CONTENT_HERE

    {/param}
  {/call}
{/template}

Update the three placeholders in all caps and you should be good to go!