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

Optimize filter for includes #118

Merged
merged 7 commits into from
Jun 19, 2021
Merged
Show file tree
Hide file tree
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
18 changes: 1 addition & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,20 +12,4 @@ To install this package (Julia ≥1.6), use
pkg> add Books
```

Next, go into a directory containing the Julia project for a book that you want to build.
See the `docs` folder of this project for an example project.
Then, you can serve your book as a website via

```
julia --project -ie 'using Books; serve()'
```

and create a PDF with

```
julia> using Books

julia> pdf()
```

For more information, see the [documentation](https://rikhuijzer.github.io/Books.jl/).
See, the [documentation](https://rikhuijzer.github.io/Books.jl) for more information.
8 changes: 4 additions & 4 deletions docs/contents/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,14 @@ To create single pages and PDFs containing code blocks, see [Weave.jl](https://g
One of the main differences with Franklin.jl, Weave.jl and knitr (Bookdown) is that this package completely decouples the computations from the building of the output.
The benefit of this is that you can spawn two separate processes, namely the one to serve your webpages:

```{.include}
_gen/serve_example.md
```jl
serve_example()
```

and the one where you do the computations for your package `Foo`:

```{.include}
_gen/generate_example.md
```jl
generate_example()
```

This way, the website remains responsive when the computations are running.
Expand Down
Loading