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

Convert readme to markdown #1087

Closed
casey opened this issue Feb 4, 2022 · 5 comments · Fixed by #1091
Closed

Convert readme to markdown #1087

casey opened this issue Feb 4, 2022 · 5 comments · Fixed by #1091

Comments

@casey
Copy link
Owner

casey commented Feb 4, 2022

Now that GitHub auto-generates a table of contents, I think asciidoc has outlived its usefulness, and I should convert the readme to markdown so I don't have to remember the asciidoc syntax.

@casey casey linked a pull request Feb 7, 2022 that will close this issue
@kenden
Copy link
Contributor

kenden commented Feb 9, 2022

Now that GitHub auto-generates a table of contents

@casey Now that the README.md is in markdown, is the table of contents coming back? I find it helpful to navigate the docs and don't see it anymore, am I missing it?

@casey
Copy link
Owner Author

casey commented Feb 9, 2022

GitHub actually automatically generates a table of contents now, but it can be hard to find. There's a button that opens a drop-down menu, which has a search bar to search for individual sections.

Screen Shot 2022-02-09 at 1 47 21 PM

@casey
Copy link
Owner Author

casey commented Feb 9, 2022

(It's the icon to the left of README.md.)

@kenden
Copy link
Contributor

kenden commented Feb 10, 2022

@casey thank you!
I just saw a README.me with the text:
Feeling lost? Use the GitHub TOC!), here: https://github.com/nanotee/nvim-lua-guide

Do you think this would be a good idea to add this here too?

@casey
Copy link
Owner Author

casey commented Feb 10, 2022

Sounds reasonable to me, I just opened #1096 to add an arrow pointing to the table of contents.

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 a pull request may close this issue.

2 participants