Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add LiveServer.jl as an option for running a local web server #1383

Merged
merged 2 commits into from
Aug 2, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions docs/src/man/guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,8 +141,11 @@ build/
not resolve directory URLs like `foo/` to `foo/index.html` for local files. You have two
options:

1. You can run a local web server out of the `docs/build` directory. If you have Python
installed, you can simple start one with `python3 -m http.server --bind localhost`
1. You can run a local web server out of the `docs/build` directory. One way to accomplish
this is to install the [LiveServer](https://github.com/asprionj/LiveServer.jl) Julia
package. You can then start the server with
`julia -e 'using LiveServer; cd("docs/build"); serve()'`. Alternatively, if you have Python
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

serve(dir="docs/build") might be nicer.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

installed, you can start one with `python3 -m http.server --bind localhost`
(or `python -m SimpleHTTPServer` with Python 2).

2. You can disable the pretty URLs feature by passing `prettyurls = false` with the
Expand Down