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

Switch to Quarto #69

Merged
merged 12 commits into from
Oct 8, 2021
Merged

Switch to Quarto #69

merged 12 commits into from
Oct 8, 2021

Conversation

officialcjunior
Copy link
Member

@officialcjunior officialcjunior commented Sep 23, 2021

Description

This PR switches the Rizin book to Quarto which is an open-source scientific and technical publishing system built on Pandoc. Quarto documents are authored using markdown, an easy to write plain text format.

At the time of opening this PR, the initial import is done and all the Markdown files work and its HTML files are generated properly:

image

The HTML files are generated and stored inside a folder named docs.

Testing

Checkout this branch, get Quarto from the releases page and run:
$ quarto render /path/to/rz/book

Closes #60

Also depends (to toggle the TOC like with mdBook before) on quarto-dev/quarto-cli#110

@XVilka
Copy link
Member

XVilka commented Sep 24, 2021

Looks like used Quarto version is old:

  # Hardcoding versions for now to make sure new versions don't break things
  quarto_version="0.2.153"
  quarto_file_name="quarto-${quarto_version}-amd64.deb"
  quarto_url="https://github.com/quarto-dev/quarto-cli/releases/download/v${quarto_version}/${quarto_file_name}"
  
  wget -q "${quarto_url}"
  
  sudo dpkg -i "${quarto_file_name}"

See https://github.com/quarto-dev/quarto-cli/releases

@XVilka
Copy link
Member

XVilka commented Sep 26, 2021

Could you please also add the render to PDB and ePub?

quarto render document.md --to pdf
quarto render document.md --to epub

@XVilka
Copy link
Member

XVilka commented Sep 27, 2021

Now we need to make these PDFs and ePub available from the site itself somehow.

@officialcjunior
Copy link
Member Author

I think we can just link it on the index.md, which will make it appear on the page put as the screenshot at the beginning of this PR.

https://github.com/rizinorg/book/pull/69/files#diff-a48746cae70c44e7e105b594aad338ddd105c93c1cb445a40ba6aab785ba69e5

@officialcjunior officialcjunior marked this pull request as ready for review October 1, 2021 09:57
_quarto.yml Outdated Show resolved Hide resolved
@XVilka
Copy link
Member

XVilka commented Oct 7, 2021

Why there is so many differences between MD files? Please rebase on top of the latest dev, also remove then the autogenerated files completely - they will be generated by the CI job.

seanachao and others added 12 commits October 8, 2021 09:36
* Run Codepspell to fix spelling mistakes (#45)
* Document Print Gadgets
* Specify what exactly gadgets are
* Specify that Visual gadgets are unrelated with print gadgets
* Adding rz-diff documentation with examples and changing iS output for Sections

* remove spaces

* Add -S option

* Resolve suggestions

* Resolve suggestions

* remove diff definition
* new tutorial for find the easy pass of hackthebox challenges. (#63)

Add a new tutorial for finding the easy pass of hackthebox challenges

* Fix the broken links due names being lowercase. (#64)

* Document CPU and platform profiles

* Document the configuration variable `asm.platform`

* Address changes and wrap the lines up nicely

Co-authored-by: bemojo2021 <85988120+bemojo2021@users.noreply.github.com>
@XVilka XVilka merged commit ab8d108 into dev Oct 8, 2021
@XVilka XVilka deleted the quarto branch October 8, 2021 04:20
nullun pushed a commit to nullun/book that referenced this pull request Sep 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants