https://github.com/JuliaBooks/Books.jl

Skip to content
 
Sign up

  * Why GitHub?
    Features -
      + Mobile -
      + Actions -
      + Codespaces -
      + Packages -
      + Security -
      + Code review -
      + Issues -
      + Integrations -
      + GitHub Sponsors -
      + Customer stories-
  * Team
  * Enterprise
  * Explore
      + Explore GitHub -

    Learn and contribute

      + Topics -
      + Collections -
      + Trending -
      + Learning Lab -
      + Open source guides -

    Connect with others

      + The ReadME Project -
      + Events -
      + Community forum -
      + GitHub Education -
      + GitHub Stars program -
  * Marketplace
  * Pricing
    Plans -
      + Compare plans -
      + Contact Sales -
      + Education -

[                    ] 

  *  
    #
    In this repository All GitHub |
    Jump to |

  * No suggested jump to results

  *  
    #
    In this repository All GitHub |
    Jump to |
  *  
    #
    In this organization All GitHub |
    Jump to |
  *  
    #
    In this repository All GitHub |
    Jump to |

Sign in
Sign up
{{ message }}

JuliaBooks / Books.jl Public

  * 
  * Notifications
  * Star 152
  * Fork 11
  * 

Create books with Julia

books.huijzer.xyz
View license
152 stars 11 forks
Star
Notifications

  * Code
  * Issues 25
  * Pull requests 0
  * Actions
  * Security
  * Insights

More

  * Code
  * Issues
  * Pull requests
  * Actions
  * Security
  * Insights

main
Switch branches/tags
[                    ]
Branches Tags
Could not load branches
Nothing to show
{{ refName }} default View all branches
Could not load tags
Nothing to show
{{ refName }} default
View all tags
3 branches 47 tags
Code

Latest commit

@rikhuijzer
rikhuijzer Update README.md
...
1e7c315 Oct 31, 2021
Update README.md
1e7c315

Git stats

  * 420 commits

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
.github
Set cname to books.huijzer.xyz
Oct 5, 2021
defaults
Add disable-cleardoublepage option (#238)
Oct 10, 2021
docs
Tryout Pirsch
Oct 15, 2021
src
Refactor serve.jl (#243)
Oct 19, 2021
test
Fix old references (#239)
Oct 10, 2021
.gitattributes
Add .gitattributes
Mar 9, 2021
.gitignore
Remove Lua filter (#170)
Aug 14, 2021
Artifacts.toml
Bump highlight to version 11.3.1 (#242)
Oct 18, 2021
LICENSE.md
Fix monofont appearance in listings (#203)
Sep 6, 2021
Project.toml
Set version to 1.1.3
Oct 16, 2021
README.md
Update README.md
Oct 31, 2021
View code
Books.jl Create books with Julia Usage Windows Getting help

README.md

             [137941103-50f5d3a8-b447-4b09-807d-7161ce]

                               Books.jl

                       Create books with Julia

    CI Documentation Code Style Blue Collaborative Practices for
             Community Packages Documentation analytics

In a nutshell, this package is meant to generate books (or reports or
dashboards) with embedded Julia output. Via Pandoc, the package can
live serve a website and build various outputs including a website,
PDF, and DOCX. For many standard output types, such as DataFrames and
plots, the package can run your code and will automatically handle
proper embedding in the output documents, and also try to guess
suitable captions and labels. Also, it is possible to work via the
live server, which shows changes within seconds.

This package assumes that:

  * the user is comfortable with managing two REPLs,
  * the user wants to run Julia code and embed the output in a book,
  * the book (website, PDF and DOCX) is built via CI, and
  * Markdown sections and subsections (level 2) should be numbered
    and listed in the HTML menu.

The reason that numbering of sections is always assumed is to allow
the book to be printed. Without section numbers, it is difficult to
refer to other parts of the book.

If you do not want numbered sections, but instead a more dynamic
website with links, then checkout Franklin.jl. If you want a small
report instead of a book with numbered sections, then Weave.jl might
be more suitable for your problem. For smaller projects and a
friendlier interface, take a look at Pluto.jl.

This package was used to write the Julia Data Science book.

 Usage

To install this package (Julia 1.6/1.7 on MacOS/Linux), use

pkg> add Books

See, the documentation for more information.

 Windows

Currently, this package (probably) does not work on Windows. The
fixes should be fairly easy. I simply have to look into it a bit
more.

 Getting help

If you run into problems when using this package, feel free to open
an issue here at GitHub or click this link to ask a question at
Discourse. For short questions, feel free to send me a PM at https://
julialang.slack.com.

About

Create books with Julia

books.huijzer.xyz

Topics

pdf books julia pandoc bookdown

Resources

Readme

License

View license

Releases 47

 
v1.1.3 Latest
Oct 16, 2021
+ 46 releases

Sponsor this project

 
Sponsor
Learn more about GitHub Sponsors

Packages 0

No packages published

Contributors 4

  * @rikhuijzer rikhuijzer Rik Huijzer
  * @findmyway findmyway Jun Tian
  * @github-actions[bot] github-actions[bot]
  * @TheCedarPrince TheCedarPrince

Languages

  * Julia 100.0%

  * (c) 2021 GitHub, Inc.
  * Terms
  * Privacy
  * Security
  * Status
  * Docs

 

  * Contact GitHub
  * Pricing
  * API
  * Training
  * Blog
  * About

You can't perform that action at this time.
You signed in with another tab or window. Reload to refresh your
session. You signed out in another tab or window. Reload to refresh
your session.