Skip to content
This repository was archived by the owner on Nov 23, 2021. It is now read-only.

Commit 518a1b9

Browse files
committed
Emphasize search bar constraints
1 parent a0a37b7 commit 518a1b9

File tree

2 files changed

+22
-0
lines changed

2 files changed

+22
-0
lines changed

docs/how_do_i_run_ditto_locally.md

+21
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,24 @@ Python's `SimpleHTTPServer` like so:
99

1010
Once the server is instaciated it should begin serving your documentation at
1111
address `127.0.0.1:8000`.
12+
13+
14+
15+
## Alternatives - LiveReload
16+
17+
Personally I find it very convenient when editing markdown files in ditto
18+
whilst using a python tool called [LiveReload][livereload]. The tool
19+
automatically refreshes the page you are editing, giving you a dreamweaver like
20+
live-preview of the doc you are editing.
21+
22+
pip install livereload
23+
cd <your repo> livereload
24+
# serving on 127.0.0.1:35729 ...
25+
26+
If you run livereload at the root of your repo, it detects any file changes
27+
and automatically refreshes the page. What I normally do is have browser and
28+
editor side by side, as I type and save, the content on the browser gets
29+
automatically refreshed.
30+
31+
32+
[livereload]: https://github.com/lepture/python-livereload

docs/how_do_i_use_ditto.md

+1
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,7 @@ If you want the GitHub search bar enter the following in the same file:
110110
[ditto:searchbar]
111111

112112
**IMPORTANT NOTE**:
113+
- **This will only search markdown files in your repo's master branch.**
113114
- Add `#` infront of `docs`, where `docs` is the folder where `document_1.md` resides
114115
- Also ___DO NOT___ INCLUDE THE FILE EXTENSION AT THE END!
115116

0 commit comments

Comments
 (0)