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

Converting to mdbook #53

Closed
wants to merge 9 commits into from
Closed

Conversation

DaseinPhaos
Copy link

@DaseinPhaos DaseinPhaos commented Feb 15, 2017

As discussed in issue#6, this PR tries to add rendering and testing support for the project with mdbook.

To maintain the current structure of the project while playing nicely with mdbook's building system, a dirty script was added into the project. Currently, just type cargo run render in the shell, the rendered pages would be ready for publishing in a subdirectory called book/. Check it out on gh-pages.

Currently two problems remains:

  • testing with cargo run test would fail,
  • introductions to subcategories are empty.

Hopefully both problems would be gone after their related PRs being merged into master.

Related: #51 #43

@simonsan simonsan reopened this Dec 31, 2020
@simonsan simonsan added C-addition Category: Adding new content, something that didn't exist in the repository before S-review Status: A PR that is currently under review or where a review is the next step labels Dec 31, 2020
@simonsan simonsan mentioned this pull request Jan 1, 2021
1 task
Copy link
Collaborator

@simonsan simonsan left a comment

Choose a reason for hiding this comment

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

I tested it and I assume this PR might be outdated due to feature additions to mdbook. I added a book.toml in #111 and it basically does the same without any changes to the repository structure (besides the additions of a Readme.md file for each subfolder/subcategory). So imho we could close this and continue work in #111 @MarcoIeni , your thoughts?

@simonsan simonsan added the C-outdated Category: Content that is outdated and needs a rework label Jan 1, 2021
@MarcoIeni
Copy link
Collaborator

I close this in favor of #111 since I think that a lot of the work done for this PR is not required anymore with newer versions of mdbook.
By the way thanks DaseinPhaos for your work!

@MarcoIeni MarcoIeni closed this Jan 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-addition Category: Adding new content, something that didn't exist in the repository before C-outdated Category: Content that is outdated and needs a rework S-review Status: A PR that is currently under review or where a review is the next step
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants