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.

Sign up for GitHub

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

Jump to bottom

mdBook 📗 😍 #91

Closed
nelsonic opened this issue Feb 2, 2023 · 8 comments
Closed

mdBook 📗 😍 #91

nelsonic opened this issue Feb 2, 2023 · 8 comments
Assignees
@nelsonic
Labels
discuss Share your constructive thoughts on how to make progress with this issue enhancement New feature or enhancement of existing functionality priority-2 Second highest priority, should be worked on as soon as the Priority-1 issues are finished T1h Time Estimate 1 Hour technical A technical issue that requires understanding of the code, infrastructure or dependencies

Comments

@nelsonic
Copy link
Member

nelsonic commented Feb 2, 2023

The tool that is used to make the Rust Book: https://doc.rust-lang.org/book
is mdBook: https://github.com/rust-lang/mdBook
image

Going to try and use it now on localhost. 👨‍💻 ⏳
@nelsonic nelsonic added enhancement New feature or enhancement of existing functionality priority-2 Second highest priority, should be worked on as soon as the Priority-1 issues are finished technical A technical issue that requires understanding of the code, infrastructure or dependencies discuss Share your constructive thoughts on how to make progress with this issue T1h Time Estimate 1 Hour labels Feb 2, 2023
@nelsonic nelsonic self-assigned this Feb 2, 2023
@nelsonic
Copy link
Member Author

nelsonic commented Feb 2, 2023

https://rust-lang.github.io/mdBook/guide/installation.html
https://rust-lang.github.io/mdBook/guide/creating.html

@nelsonic
Copy link
Member Author

nelsonic commented Feb 5, 2023

Test-driving Native Markdown Editor: nelsonic/amemo#60 for distraction free writing ... ✍️

@nelsonic
Copy link
Member Author

nelsonic commented Feb 5, 2023

Publishing mdBook on Github Pages: https://users.rust-lang.org/t/publishing-mdbook-on-github-page/75132
-> https://github.com/rust-lang/mdBook/wiki/Automated-Deployment%3A-GitHub-Actions

@nelsonic
Copy link
Member Author

nelsonic commented Feb 5, 2023

Testing out: https://github.com/rust-lang/mdBook/wiki/Automated-Deployment%3A-GitHub-Actions#jamesivesgithub-pages-deploy-action 🤞

nelsonic added a commit that referenced this issue Feb 5, 2023
@nelsonic
create mdBook see: #91
8166ee9
nelsonic added a commit that referenced this issue Feb 5, 2023
@nelsonic
create deploy.yml to deploy to GitHub Pages #91 (comment)
c55e3f9
nelsonic added a commit that referenced this issue Feb 5, 2023
@nelsonic
add index.html to .gitignore #91
98b9115
nelsonic added a commit that referenced this issue Feb 5, 2023
@nelsonic
testing mdbook -> GitHub pages action #91
f47c0f5
nelsonic added a commit that referenced this issue Feb 5, 2023
@nelsonic
use JamesIves/github-pages-deploy-action for building GHpages book #9…
41406f6 
…1 (comment)
nelsonic added a commit that referenced this issue Feb 5, 2023
@nelsonic
temporarily disable link checking #91
a83309b
@nelsonic nelsonic mentioned this issue Feb 5, 2023
Closed
@nelsonic nelsonic moved this to 🏗 In progress in dwyl app kanban Feb 5, 2023
nelsonic added a commit that referenced this issue Feb 6, 2023
@nelsonic
attempt to fix validation error: https://github.com/dwyl/book/actions…
1e7598e 
…/runs/4102325105/jobs/7075140729#step:12:9 #91
nelsonic added a commit that referenced this issue Feb 6, 2023
@nelsonic
fix broken images in intro-to-testing.md #91
82fe605
nelsonic added a commit that referenced this issue Feb 6, 2023
@nelsonic
attempt to add theme/head.hbs for analytics #91
b42d3ea
@nelsonic
Copy link
Member Author

nelsonic commented Feb 7, 2023

Trying to customise the <head> to include plausible/analytics: dwyl/technology-stack#127
Reading: https://rust-lang.github.io/mdBook/format/theme/index.html

@nelsonic
Copy link
Member Author

nelsonic commented Feb 7, 2023

Created: https://github.com/dwyl/book/blob/main/theme/head.hbs

book/theme/head.hbs

Line 1 in b42d3ea

<script defer data-domain="dwyl.github.io" src="https://plausible.io/js/script.js"></script>

But doesn't seem to be included in the latest build of: https://dwyl.github.io/book
Need to make time to investigate this.
But have to get back to my "work work" now ... ⌛

@nelsonic
Copy link
Member Author

nelsonic commented Feb 7, 2023

https://plausible.io/dwyl.github.io?page=%2Fbook%2F
image

😉

@nelsonic nelsonic moved this from 🏗 In progress to ✅ Done in dwyl app kanban Feb 10, 2023
@nelsonic
Copy link
Member Author

Confident that this will be a good way forward. Closing. ✅

nelsonic added a commit that referenced this issue Feb 18, 2023
@nelsonic
rename main.yml to ci.yml for consistency with our other projects #91
443f460
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@nelsonic nelsonic

Labels
discuss Share your constructive thoughts on how to make progress with this issue enhancement New feature or enhancement of existing functionality priority-2 Second highest priority, should be worked on as soon as the Priority-1 issues are finished T1h Time Estimate 1 Hour technical A technical issue that requires understanding of the code, infrastructure or dependencies
Projects
dwyl app kanban
Status: ✅ Done
Milestone
No milestone
Development

No branches or pull requests
1 participant
@nelsonic