HandBrake/HandBrake-docs
1
0
Fork 0
mirror of https://github.com/HandBrake/HandBrake-docs.git synced 2025-12-11 13:54:49 -06:00
Code Issues Packages Projects Releases 1 Wiki Activity

Update Contributing to specify external markdown path.

Browse Source
This commit is contained in:
Bradley Sepos 2018-02-25 17:32:42 -05:00
parent 118fb58cc6
commit 71f99e6b30
No known key found for this signature in database
GPG Key ID: DEADE2F57D42D9C7
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CONTRIBUTING.markdown
View File

@ -176,7 +176,7 @@ Every copy of the source files includes additional third-party tools needed buil
Run `build-tools` from the main directory to build all associated third-party tools.
Once the tools are built, run `marsh build` from the main directory to build the HTML documentation in the `public/docs` directory. You may now view and interact with the documentation by opening `public/docs/index.html` in your web browser.
Once the tools are built, run `marsh build --markdown=tools/local/bin/markdown` from the main directory to build the HTML documentation in the `public/docs` directory. You may now view and interact with the documentation by opening `public/docs/index.html` in your web browser.
Security restrictions in modern web browsers may prevent web fonts from displaying properly when viewing local files. One workaround is to serve the files instead of opening them directly. From the `public` directory, run `python -m http.server 8000 || python -m SimpleHTTPServer 8000` and then open `http://localhost:8000/docs/` in your web browser (requires Python).