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

install mkdocs plugins #1649

Closed
River-Mochi opened this issue Apr 5, 2023 · 0 comments
Closed

install mkdocs plugins #1649

River-Mochi opened this issue Apr 5, 2023 · 0 comments
Assignees

Comments

@River-Mochi
Copy link
Contributor

River-Mochi commented Apr 5, 2023

Describe the bug

Please install following plugins so they can be used in the mkdocs.yml config.
some of these are missing which is causing the error on building the PR, messages are that pymdown is down

pip install pymdown-extensions
pip install mkdocs-git-revision-date-plugin
pip install mkdocs-autolinks-plugin
pip install mkdocs-awesome-pages-plugin

reference:

  1. allows a collection of markdowns such as using github emoji, or other icons in the docs. https://facelessuser.github.io/pymdown-extensions/

  2. Autolinks allows you to link to pages and images within MkDocs site without providing the entire relative path to the file in your document structure https://github.com/zachhannum/mkdocs-autolinks-plugin

  3. Git-revision-date displays the last revision date of the current page of the documentation based on Git.
    https://github.com/zhaoterryy/mkdocs-git-revision-date-plugin
    then add this to footer of pages Page last revised on: {{ git_revision_date }}

  4. awesome-pages allows you to customize how your pages show up the navigation of your MkDocs without having to configure the full structure inside your mkdocs.yml.
    Allows more fine control of this means that when ready, all the nav: could be moved out of YML and put into .pages (one .page for each folder).
    https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin

River-Mochi added a commit to River-Mochi/IronOS that referenced this issue Apr 7, 2023
Ralim added a commit that referenced this issue Apr 7, 2023
* fix: edit button mkdocs

* fix: edit button on mkdocs

- should open edit page for  dev branch and requires  login if person is not already logged into github

* add favicons for the  mkdocs

* Delete android-chrome-192x192.png

* Delete android-chrome-512x512.png

* Delete favicon-16x16.png

* Delete favicon.ico

* Delete favicon-32x32.png

* Delete apple-touch-icon.png

* Create temp

* add favicon for mkdocs

* mkdocs - highlighting for source code

- Enables highlighting of source code in code blocks
- allow highlighting for other languages that are not default 23
- add favicon and custom location (until  folder names are changed to /docs  and /doc/img

* Delete temp

* Add files via upload

* organize mkdocs

* add mkdocs extensions & plugins

* remove favicon

* Delete favicon.ico

* Delete font-license.txt

* fix mkdocs for  markdown extensions

fixed the name since  this is not a materials theme.

* add plugins  to mkdocs

* add mkdocs git-revision-date

displays the last revision date of the current page of the documentation based on Git. this could be displayed at the bottom of each page.

* add plugins for MKdocs

* closes ticket  #1649

* clean up mkdocs plugins

break up code line as it's getting too long with more plugins.

* fix pip install comand

* fix typo

---------

Co-authored-by: Ben V. Brown <5425387+Ralim@users.noreply.github.com>
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