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

fix Mkdocs edit button #1642

Merged
merged 19 commits into from
Apr 4, 2023
Merged

fix Mkdocs edit button #1642

merged 19 commits into from
Apr 4, 2023

Conversation

River-Mochi
Copy link
Contributor

@River-Mochi River-Mochi commented Apr 2, 2023

  • What kind of change does this PR introduce?
    bug fix , edit button does not work on Mkdoc ironos

Can not really test this until it goes live , but it should fix the "Edit on Github" button.
button should....

  1. open Dev branch, Documentation folder
  2. prompt person to login if they are not logged into github.
  3. we think it will open the user's private fork of ironos for the editing (optimal result)

- should open edit page for  dev branch and requires  login if person is not already logged into github
- 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
Documentation/img/favicon.ico Outdated Show resolved Hide resolved
@River-Mochi
Copy link
Contributor Author

River-Mochi commented Apr 4, 2023

just delete that for now then and we find something else. or accept it as a placeholder.
see here it's easy to change it. just one line in the YML
https://www.mkdocs.org/getting-started/#changing-the-favicon-icon

but accept the other changes please. I added a section so we have more markdown support.

@Ralim
Copy link
Owner

Ralim commented Apr 4, 2023

You need to remove the file from the PR before I can merge it in.
Happy to merge other changes without the favicon 😁

@River-Mochi
Copy link
Contributor Author

River-Mochi commented Apr 4, 2023

You need to remove the file from the PR before I can merge it in.

deleted/ done
do you have time to change Documentation to /docs
and have images in /docs/img

but then some things might point to Documentation so not sure if you have a fast command line to fix any of those.

at the same time that /docs is made then that line for Documentation can be removed from the YML

@Ralim Ralim merged commit 84095a8 into Ralim:dev Apr 4, 2023
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

Successfully merging this pull request may close these issues.

2 participants