search

pdeffebach / ClipData.jl

Move data to and from the clipboard in Julia
https://pdeffebach.github.io/ClipData.jl/stable/
MIT License
82 stars 6 forks source link

[infra question: ReadMe as docs homepage] #28

Open tfiers opened 1 year ago

tfiers commented 1 year ago

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 commented 1 year ago

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

tfiers commented 1 year ago

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")