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

Hi I am looking for an indexing solution for a markdown archive #62

Open
b9Joker108 opened this issue Mar 6, 2024 · 1 comment
Open
Labels
question Further information is requested

Comments

@b9Joker108
Copy link

b9Joker108 commented Mar 6, 2024

Hi

I am prospecting solutions to generate an index for a markdown archive. I initially started the document in Notion, the one page document got too large for Notion, so I migrated to GitHub. GitHub was going great-guns, except the one-page document has grown too large to visually render and edit in a GitHub repository. I am currently prospecting Mdbook and Gitbook as solutions. I know it may be best to break the book down into smaller files, but I am resisting doing so, as I Intuit the workflow of transforming it into PDF, Wiki, Website, Latex, for example, each of these formats, subsuming three modes: one page in total, archive in nodes, a conceptual tree; a table of contents and traditional index, both hyperlinks/hypertext/metatext. I feel if the document is in one page form, all these transmutations, will be easier.

So, I came across your project and wondered if it is a solution for generating an index from a complex or archive of documents? Also, I am working within Termux on Android, but also have PRoot-distro alias installations of GNU/Linux distributions, such as Debian, amongst others.

I really hope your project is a workable solution.

I await your advice.

Thanking you in anticipation
Beauford

P.S.

I installed your project no probs in Termux. Does it generate an index according to heading sections or pages or...?

@darkmavis1980
Copy link
Owner

The script is very simple, what it does it scans for headings from H2 to H5, and generate the index out of it, it doesn't look for pages or anything else

@darkmavis1980 darkmavis1980 added the question Further information is requested label Mar 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants