Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/access-nri/mkdoc-template

A template repository for the deployment of mkdocs for model configuration documentation and tools

https://github.com/access-nri/mkdoc-template

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (5.9%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

A template repository for the deployment of mkdocs for model configuration documentation and tools

Basic Info
  • Host: GitHub
  • Owner: ACCESS-NRI
  • License: apache-2.0
  • Default Branch: main
  • Size: 715 KB
Statistics
  • Stars: 0
  • Watchers: 0
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created 10 months ago · Last pushed 10 months ago
Metadata Files
Readme License

README.md

General Mkdoc Template

A template repository for the deployment of mkdocs for model configuration documentation and tools

Get started...

Clone the repo

Edit the following file replacing mkdoc-template as appropriate and including your relevant files in the table of contents (see next point) - mkdoc-template/documentation/mkdocs.yml

Start creating content and putting markdown files here - /mkdoc-template/documentation/docs/pages

Default landing page is here - mkdoc-template/documentation/docs/pages/index.md

Turn on rendering of GitHub Pages, go to Settings --> Pages --> Build and deployment for Source choose Github Actions.

Owner

  • Name: ACCESS-NRI
  • Login: ACCESS-NRI
  • Kind: organization
  • Email: access.nri@anu.edu.au

Australian Earth System Simulator - National Research Infrastructure

GitHub Events

Total
  • Member event: 1
  • Push event: 1
  • Public event: 1
  • Fork event: 1
Last Year
  • Member event: 1
  • Push event: 1
  • Public event: 1
  • Fork event: 1

Dependencies

.github/workflows/deploy_to_github_pages.yml actions
  • access-nri/actions/.github/actions/comment main composite
  • actions/checkout v4 composite
  • actions/deploy-pages d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e composite
  • actions/setup-python v5 composite
  • actions/upload-pages-artifact 56afc609e74202658d3ffba0e8f6dda462b719fa composite
documentation/requirements.txt pypi
  • mkdocs-bibtex ==4.4.0
  • mkdocs-git-revision-date-localized-plugin ==1.2.0
  • mkdocs-macros-plugin ==1.0.4
  • mkdocs-material ==9.6.11
  • pypandoc_binary ==1.15