Skip to content

Commit b67642e

Browse files
committed
papis-html: update readme
1 parent ca42370 commit b67642e

File tree

1 file changed

+12
-15
lines changed

1 file changed

+12
-15
lines changed

papis-html/README.rst

Lines changed: 12 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,26 @@
11
.. image:: https://badge.fury.io/py/papis-html.svg
22
:target: https://badge.fury.io/py/papis-html
33

4-
Papis-HTML
4+
papis-html
55
==========
66

7-
::
8-
9-
Usage: papis-html [OPTIONS] [QUERY]
10-
11-
Create a simple searchable offline html site with your references
7+
For instance, doing
128

13-
Options:
14-
-h, --help Show this message and exit.
15-
--out TEXT Output directory
9+
.. code:: sh
1610
17-
For instance, doing
11+
papis html einstein -o einstein-papers
1812
19-
::
13+
will get you a directory ``einstein-papers`` with a website inside. This website
14+
uses local files, so may not work directly when opened in a modern browser
15+
(due to XSS precautions). You can start a simple web server in the generated
16+
directory with
2017

21-
papis html einstein -o einstein-papers
18+
.. code:: sh
2219
23-
will get you a directory ``einstein-papers`` with a website inside.
20+
python -m http.server -d einstein-papers -b 127.0.0.1 8000
21+
firefox 127.0.0.1:8000
2422
25-
You can find an example in
26-
`here <https://papis.github.io/papis-html/einstein/>`_.
23+
You can find an example `here <https://papis.github.io/papis-html/einstein/>`__.
2724

2825
Acknowledgements
2926
================

0 commit comments

Comments
 (0)