Skip to content

Generate anchors when building instead of using JavaScript #204

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

Closed
azerupi opened this issue Feb 15, 2017 · 9 comments
Closed

Generate anchors when building instead of using JavaScript #204

azerupi opened this issue Feb 15, 2017 · 9 comments

Comments

@azerupi
Copy link
Contributor

azerupi commented Feb 15, 2017

The Rust team uses a linkchecker tool, but since anchors are generated by JavaScript code, it can't check if those anchors are valid.

It would be a better solution to generate anchors when building the book. This would also be a step in the right direction for no-js people too.

rust-lang/rust#39856

@steveklabnik
Copy link
Member

@azerupi so, two things.

  1. you don't have cycles for mdbook right now, so we would have to implement this, right?
  2. are you interested in changing the link generation to be the same as rustdoc?

I don't have strong feelings about the second bit, but would prefer to know before I go tweaking a ton of links 😄 /cc @frewsxcv

@azerupi
Copy link
Contributor Author

azerupi commented Feb 16, 2017

you don't have cycles for mdbook right now

I am not sure I understand what you are talking about.

are you interested in changing the link generation to be the same as rustdoc?

I thought the anchor generation was changed to be the same as GitHub, is that not how rustdoc handles it? How would it differ from now?

I don't have strong preferences :)

@steveklabnik
Copy link
Member

I am not sure I understand what you are talking about.

Sorry, I meant "development cycles", in another PR you had said school meant you didn't have a ton of time to work on mdbook. I'm trying to make sure I respect your time here :)

I thought the anchor generation was changed to be the same as GitHub, is that not how rustdoc handles it? How would it differ from now?

in the PR; I made this change, I left a comment next to the algorithm 😄

@azerupi
Copy link
Contributor Author

azerupi commented Feb 16, 2017

Oh yes indeed, I have a lot of time-consuming projects preventing me to allocate much time to personal projects 😕 But I hope I can find some time here and there to make progress on some long standing issues here, fingers crossed :)

@steveklabnik
Copy link
Member

Great! If you need maintenance help, now that rust is officially using mdbook, @frewsxcv and I might be willing to help, depending. Up to you of course!

@azerupi
Copy link
Contributor Author

azerupi commented Feb 16, 2017

Actually, I have been meaning to talk to you about that :)
Considering my limited time and the fact that Rust now uses it, I would be ok with adding you (and eventually others) as contributors, or even move mdBook to an "organization" with multiple maintainers. I want to make sure that mdBook is reliable for the users and can grow without me being the limiting factor.

I am open for whatever would be best :)

@steveklabnik
Copy link
Member

That'd be great! Is there any way you could make it to the next docs meeting? They're wednesdays at 20:00 GMT. Otherwise, we can schedule a specific time 😄

@azerupi
Copy link
Contributor Author

azerupi commented Feb 16, 2017

Yes, I should be able to join :) It is on IRC right?

@steveklabnik
Copy link
Member

Yes, #rust-docs on mozilla's IRC. I'll add an agenda item :)

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

No branches or pull requests

2 participants