AaronFiore/plaintextaccounting
1
0
Fork 0
Code Activity

convert numbered lists to github markdown

Browse Source
This commit is contained in:
Simon Michael
2019-04-17 17:28:19 -07:00
parent 8bb40456af
commit bbdf3178b8
1 changed files with 15 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@@ -13,26 +13,26 @@ allowing it to be served with the custom `plaintextaccounting.org` domain.
(Ok for trivial updates) (Ok for trivial updates)
#. Log in to Github and click the pencil at 1. Log in to Github and click the pencil at
[index.md](https://github.com/plaintextaccounting/plaintextaccounting.github.io/blob/master/index.md). [index.md](https://github.com/plaintextaccounting/plaintextaccounting.github.io/blob/master/index.md).
#. Make your changes to the markdown source. Commit. 2. Make your changes to the markdown source. Commit.
#. Make the corresponding changes in the generated [index.html](https://github.com/plaintextaccounting/plaintextaccounting.github.io/blob/master/index.html). Commit. 3. Make the corresponding changes in the generated [index.html](https://github.com/plaintextaccounting/plaintextaccounting.github.io/blob/master/index.html). Commit.
It's ok to skip this step if you must; we'll update the html for you. It's ok to skip this step if you must; we'll update the html for you.
#. These commits will be bundled into a pull request (I think). 4. These commits will be bundled into a pull request (I think).
Or will be applied immediately if you have commit access. Or will be applied immediately if you have commit access.
### How to contribute an update (using pandoc) ### How to contribute an update (using pandoc)
#. Log in to Github, fork this repo, clone it to your machine. 1. Log in to Github, fork this repo, clone it to your machine.
#. Make your changes to `index.md` (and/or `README.md`, `css/*`, `images/*`). 3. Make your changes to `index.md` (and/or `README.md`, `css/*`, `images/*`).
#. Regenerate `index.html` as follows: 4. Regenerate `index.html` as follows:
- Ensure you have [pandoc] 2.5+ and [GNU Make] installed, and run `make`. (Preferred). - Ensure you have [pandoc] 2.5+ and [GNU Make] installed, and run `make`. (Preferred).
- If you don't have GNU Make, you can run - If you don't have GNU Make, you can run
`pandoc -f markdown-smart+autolink_bare_uris --template index.tmpl index.md -o index.html` `pandoc -f markdown-smart+autolink_bare_uris --template index.tmpl index.md -o index.html`
- If you don't have pandoc, you can update `index.html` by hand (ok for trivial changes). - If you don't have pandoc, you can update `index.html` by hand (ok for trivial changes).
#. Commit the changes (source files and regenerated html files, eg both `index.md` and `index.html`). 4. Commit the changes (source files and regenerated html files, eg both `index.md` and `index.html`).
#. `git push` to your fork. 5. `git push` to your fork.
#. Submit a pull request. 6. Submit a pull request.
[pandoc]: http://pandoc.org/installing.html [pandoc]: http://pandoc.org/installing.html
@@ -44,11 +44,11 @@ to request it.
### How to see a live local preview ### How to see a live local preview
#. Install [entr] and [livereloadx] 1. Install [entr] and [livereloadx]
#. In one window, `make liverender` to update index.html 2. In one window, `make liverender` to update index.html
#. In another window, `make livereload` to run a live-reloading local webserver 3. In another window, `make livereload` to run a live-reloading local webserver
#. Open the page in a browser: http://localhost:10000 4. Open the page in a browser: http://localhost:10000
#. Save changes in `index.md`, see updates in the browser. 5. Save changes in `index.md`, see updates in the browser.
[entr]: http://eradman.com/entrproject/ [entr]: http://eradman.com/entrproject/
[livereloadx]: https://nitoyon.github.io/livereloadx [livereloadx]: https://nitoyon.github.io/livereloadx