ARCHIVE/xrpl-dev-portal
1
0
Fork 0
mirror of https://github.com/XRPLF/xrpl-dev-portal.git synced 2025-11-18 18:55:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

parse_pages - merge githubify; update readme

Browse Source
This commit is contained in:
mDuo13
2015-12-01 14:14:32 -08:00
parent 3052d88426
commit 82ef801cab
3 changed files with 73 additions and 61 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@@ -1,23 +1,28 @@
ripple-dev-portal
=================
The [Ripple Developer Portal](https://dev.ripple.com) is the authoritative source for Ripple documentation, including the `rippled` server, Ripple-REST API, Gatewayd, and other Ripple software.
The [Ripple Developer Portal](https://dev.ripple.com) is the authoritative source for Ripple documentation, including the `rippled` server, RippleAPI, the Ripple Data API, and other Ripple software.
Repository Layout
-----------------
The pages in this portal are generated from the markdown files in the [content/](content/) folder.
The HTML pages in this portal are generated from the markdown files in the [content/](content/) folder.
You can run your own local copy of the Dev Portal by hosting it in a web server, such as Apache. By default, the Dev Portal uses static HTML pages and client-side JavaScript (specifically, [Flatdoc](http://ricostacruz.com/flatdoc/)) to parse and display the Markdown content on the fly.
The [tool/](tool/) folder contains tools and templates for generating the HTML files in the top level. The `parse_pages.py` script (requires Python 3, [Jinja 2](http://jinja.pocoo.org/), and various pip modules) uses the templates and the [pages.json](tools/pages.json) file to generate all the HTML files on the top level. Files with "md" properties are considered documentation pages and appear in the appropriate lists. In general, `parse_pages.py` assumes you are running it with `tool/` as the current working directory.
The [tool/](tool/) folder contains tools and templates for generating the HTML files in the top level. The `parse_pages.py` script (Python 3, [Jinja 2](http://jinja.pocoo.org/), and various pip modules required) uses the templates and the [pages.json](tools/pages.json) file to generate all the HTML files on the top level. Files with "md" properties are considered documentation pages and appear in the appropriate lists. There are a few modes for generating pages:
There are a few modes for generating pages:
* The default, dynamic pages. Generates thin HTML wrappers for each page and uses Flatdoc to load and parse the contents. Great for development since a refresh automatically picks up changes to the md files.
* Pre-compiled pages. Parses the Markdown all at once and puts the contents directly into the HTML body of each file. Still experimental.
* PDF output using [Prince](http://www.princexml.com/). Still experimental.
* By default, parses the Markdown and generates all the HTML files for a locally-hosted environment.
* Local markdown files are pre-processed using Jinja so you they can have conditional logic
* You can also remotely reference a markdown file via URL. Such files are not pre-processed, though.
* Build for a specific target (e.g. `./parse_pages.py -t ripple.com`). Replaces local links with alternate versions for the target, uncomments multi-code divs (if target needs them for multi-code tabs), and performs various other cleanup.
* Watch for changes and re-build the HTML files automatically when changes occur. Example: `./parse_pages.py -w`
* Output empty HTML files and use [Flatdoc](ricostacruz.com/flatdoc/) to parse the markdown in-browser. Requires that you host the dev portal in a web server (e.g. Apache), not just open the HTML files in a browser. Example: `./parse_pages.py --flatdoc`
* Output a modified markdown file for GitHub (e.g. for sending changes back upstream). (Builds for a target, but stops at markdown instead of HTML.) e.g. `./parse_pages.py -t ripple.com -g data_v2.md > /tmp/data_v2_githubified.md`
* PDF output using [Prince](http://www.princexml.com/). Use `./parse_pages.py --pdf some_out_file.pdf`. Experimental.
To add more pages to the Dev Portal, simply modify `pages.json` and then run `parse_pages.py` again.
To add more pages to the Dev Portal, simply modify `pages.json` and then run `parse_pages.py` again. For full usage, run `parse_pages.py --help`.
Contributing
@@ -25,5 +30,5 @@ Contributing
The Developer Portal welcomes outside contributions, especially to the documentation contents. If you have any corrections, improvements, or expansions of the portal, please contribute pull requests to the **gh-pages** branch.
Contributions become copyright Ripple Labs and are provided under the MIT [LICENSE](LICENSE).
Contributions become copyright Ripple, Inc. and are provided under the MIT [LICENSE](LICENSE).