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

Hide spec from navbar #20

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Conversation

stevapple
Copy link

No description provided.

@iBug
Copy link
Member

iBug commented Dec 25, 2021

We should probably still link to the spec pages somewhere so that they remain accessible.

Linking it from README.md using relative links won't work very well because the spec pages contain mkdocs-material-specific markup that doesn't render on GitHub. The existing link to 101.lug.ustc.edu.cn looks fine to me. (P.S. removing nav items from mkdocs.yml does not stop the markdown files from being rendered.)

@stevapple
Copy link
Author

The existing link to 101.lug.ustc.edu.cn looks fine to me. (P.S. removing nav items from mkdocs.yml does not stop the markdown files from being rendered.)

This PR also moves Specs out of docs so it's not rendered.

We should probably still link to the spec pages somewhere so that they remain accessible.

If you'd like to preserve specs pages on the website, maybe we can just remove it from Nav.

@iBug
Copy link
Member

iBug commented Dec 25, 2021

I'm inclined to preserve the pages on the website because of the use of theme-specific markup. Also note that some content in the specs relies on such markup (e.g. this). Hiding them from the navbar should suffice.

@stevapple stevapple changed the title Move spec out of the site Hide spec from navbar Dec 25, 2021
@iBug
Copy link
Member

iBug commented Dec 25, 2021

I wonder if a "Spec landing page" is really necessary. Considering that it's unlikely that we add a 3rd page later on, it may be simpler to just link to both spec pages separately.

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

Successfully merging this pull request may close these issues.

2 participants