search

ACCESS-NRI / access-hive.org.au

Documentation hub for the Earth System models, ACCESS, and their community
https://access-hive.org.au/
8 stars 11 forks source link

Include a markdown file in another file: snippets extension #627

Closed ccarouge closed 3 months ago

ccarouge commented 9 months ago

Description

Markdown has the snippets extension that allows the inclusion of a Markdown file, or a section of a file, into another Markdown file. I was wondering if that would be useful for the ACCESS-Hive documentation.

The snippets documentation mentions it is using it to save all the hyperlinks to a common file. This way there is only one place to go to update a link. I know when redesigning the site, we also wondered how to deal with common parts of the instructions to run models. Would something like snippets be of interest for that purpose or have we moved on?

@atteggiani @KAUR1984 (mentioning you since this is to gauge interest and you know the Hive best now)

KAUR1984 commented 9 months ago

Thanks for that @ccarouge! That'd be really helpful as we work on cleaning file structures and minimising duplication on the Hive. Noted as a possibility for use on the Hive.

ccarouge commented 9 months ago

One nice feature is that it isn't limited to Markdown files within the documentation folder. Sean has used it to re-use the content of the README.md file within our home page. I see you are working on getting the contribution instructions in the README.md so you could then reuse that for the contribution page on the Hive itself.

atteggiani commented 9 months ago

Thank you for the infor @ccarouge!

I agree, I think in general that could be useful in many different cases, regardless how we decide to structure the website in the future.

KAUR1984 commented 4 months ago

Moving this to backlog for now :)