Make wiki look cool #23

New issue

Open

opened 2024-08-19 23:03:49 +00:00 by esy · 3 comments

esy commented

2024-08-19 23:03:49 +00:00

Owner

As it stands the wiki is pretty bare bones, there can be a lot of improvements to the styling and config of it
https://www.mkdocs.org/user-guide/configuration/
Some inspiration from a fellow society - https://docs.redbrick.dcu.ie/

As it stands the wiki is pretty bare bones, there can be a lot of improvements to the styling and config of it https://www.mkdocs.org/user-guide/configuration/ Some inspiration from a fellow society - https://docs.redbrick.dcu.ie/

esy added the

documentation

good first issue

labels 2024-08-19 23:03:49 +00:00

silver commented

2024-08-21 23:08:34 +00:00

Owner

Ye might also need to explicity say ye want other plugins enabled since by defining one it can disable teh default list.
(and be careful gettign teh edit page right)

Adding teh git info might be a good idea https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/ Would also be a good time to fix the repo url as well (currently ``Skynet/nixos``, should be ``Skynet/wiki``) Ye might also need to explicity say ye want other plugins enabled since by defining one it can disable teh default list. (and be careful gettign teh edit page right)

silver commented

2024-08-26 21:59:25 +00:00

Owner

This may be useful, though its not complete (still need to add teh packages to teh flake)

site_name: Skynet Wiki
site_url: https://wiki.skynet.ie
repo_url: https://forgejo.skynet.ie/Skynet/wiki
edit_uri: src/branch/main/src
docs_dir: ./src/
theme:
  name: material
  features:
    - search.suggest
    - search.highlight
    - navigation.expand
    - content.action.view
  icon:
    view: material/eye
plugins:
  - search
  - git-authors:
      show_email_address: false
  - git-revision-date-localized:
      enable_creation_date: true
markdown_extensions:
  - tables

This may be useful, though its not complete (still need to add teh packages to teh flake) ```yaml site_name: Skynet Wiki site_url: https://wiki.skynet.ie repo_url: https://forgejo.skynet.ie/Skynet/wiki edit_uri: src/branch/main/src docs_dir: ./src/ theme: name: material features: - search.suggest - search.highlight - navigation.expand - content.action.view icon: view: material/eye plugins: - search - git-authors: show_email_address: false - git-revision-date-localized: enable_creation_date: true markdown_extensions: - tables ```

silver commented

2024-08-26 23:01:58 +00:00

Owner

useful links (might be worth adding as comments)

useful links (might be worth adding as comments) * https://timvink.github.io/mkdocs-git-authors-plugin/options.html * https://timvink.github.io/mkdocs-git-revision-date-localized-plugin/options/