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

Improve markdown writing experience (use anchors and line formatting) #46

Open
3 tasks
iolivia opened this issue Jun 28, 2020 · 2 comments
Open
3 tasks
Labels
help wanted Extra attention is needed infra Infrastructure for the book low priority

Comments

@iolivia
Copy link
Owner

iolivia commented Jun 28, 2020

Using anchors will make it less painless to make changes without breaking the markdown and we could also use the line hiding feature of mdbook to make some of the explanations better by highlighting which lines are new/modified. High effort though, a good starting point might be doing this for new code.

https://rust-lang.github.io/mdBook/format/mdbook.html

  • Chapter 1
  • Cahpter 2
  • Chapter 3
@iolivia iolivia added new section New feature or request help wanted Extra attention is needed labels Jun 28, 2020
@iolivia iolivia added low priority infra Infrastructure for the book and removed new section New feature or request labels Jul 10, 2020
@iolivia
Copy link
Owner Author

iolivia commented Mar 20, 2021

Closing this as it's not a priority atm and likely high effort.

@iolivia iolivia closed this as completed Mar 20, 2021
@iolivia
Copy link
Owner Author

iolivia commented Nov 21, 2021

Reopening as it is very very annoying to make any change without breaking the whole book. Need a strategy for this, maybe a good first step is using it on new code and slowly adding it to old code.

@iolivia iolivia reopened this Nov 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed infra Infrastructure for the book low priority
Projects
None yet
Development

No branches or pull requests

1 participant