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

[infra question: ReadMe as docs homepage] #28

Open
tfiers opened this issue Dec 24, 2022 · 2 comments
Open

[infra question: ReadMe as docs homepage] #28

tfiers opened this issue Dec 24, 2022 · 2 comments

Comments

@tfiers
Copy link

tfiers commented Dec 24, 2022

Not an issue about the package (which is fantastic), just a question about tooling.

The docs homepage (docs/src/index.md) and the ReadMe on github seem very similar. Did you manually copy and edit or do you have a script for this?

@pdeffebach
Copy link
Owner

Manually copied. @alecloudenback wrote the docs and I just copied and pasted it into documenter.

@tfiers
Copy link
Author

tfiers commented Dec 25, 2022

I see. I currently have a hacky script that tries to do this automatically: https://github.com/tfiers/PkgGraph.jl/blob/main/docs/scripts/insert_readme_in_docs.jl
The only preprocessing is converting relative links to absolute ones. More preprocessing is needed (e.g. remove links to "The Documentation")

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