Skip to content

Hosting mdbook with gh-pages #111

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

Merged
merged 1 commit into from
Jan 1, 2021
Merged

Hosting mdbook with gh-pages #111

merged 1 commit into from
Jan 1, 2021

Conversation

simonsan
Copy link
Collaborator

@simonsan simonsan commented Jan 1, 2021

This adds a book.toml configuration file and some (still empty) Readme.md files to the categories.

Output can be followed here

Filling the descriptions of the categories I think would make sense to make in another PR, due to possible discussions about the content. For now I think just adding this should be fine. Thoughts/feedback?

Regarding the domain: Renaming this repository to 'rust-patterns' on the discussion board: #113

supersedes #53
fixes #6

@simonsan simonsan added the C-addition Category: Adding new content, something that didn't exist in the repository before label Jan 1, 2021
@simonsan simonsan marked this pull request as ready for review January 1, 2021 08:03
@simonsan simonsan changed the title [WIP] mdbook configuration Hosting mdbook with gh-pages Jan 1, 2021
@simonsan simonsan force-pushed the mdbook branch 3 times, most recently from 548e0ea to 0e09f5b Compare January 1, 2021 08:34
@simonsan simonsan added the S-review Status: A PR that is currently under review or where a review is the next step label Jan 1, 2021
@marcoieni
Copy link
Collaborator

Adding instructions on how to build the book in the readme or in contribution guidelines might be nice.
something like

cargo install mdbook
mdbook serve

@simonsan
Copy link
Collaborator Author

simonsan commented Jan 1, 2021

Adding instructions on how to build the book in the readme or in contribution guidelines might be nice.
something like

cargo install mdbook
mdbook serve

Added ;-)

@marcoieni
Copy link
Collaborator

Looks good to me.
Are you planning to add categories?

@marcoieni marcoieni mentioned this pull request Jan 1, 2021
@simonsan simonsan merged commit 3f3ae4a into master Jan 1, 2021
@simonsan simonsan deleted the mdbook branch January 1, 2021 11:50
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 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.

Convert this to a gitbook/mdbook
2 participants