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

mkdocs: Improve site part2 #860

Merged
merged 10 commits into from Sep 28, 2023
Merged

Conversation

datamweb
Copy link
Collaborator

@datamweb datamweb commented Sep 27, 2023

Description

https://datamweb.github.io/shield

See https://github.com/timvink/mkdocs-git-revision-date-localized-plugin
You need pip3 install mkdocs-git-revision-date-localized-plugin.

Checklist:

  • Securely signed commits
  • Component(s) with PHPDoc blocks, only if necessary or adds value
  • Unit testing, with >80% coverage
  • User guide updated
  • Conforms to style guide

@datamweb datamweb marked this pull request as draft September 27, 2023 05:37
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kenjis has a warning due to the use of dotenv. It seems that the solution is not to use dotenv or write a plugin for highlight or use class nohighlight. Not sure how to fix it now. We continue with the same conditions.

WARN: Could not find the language 'dotenv', did you forget to load/include a language module?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you mean?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kenjis see:
Screenshot 2023-09-28 140217

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems ```dotenv is not supported by highlight.js.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, exactly, the solution is to write a plugin(like what was done for curl) or reject an interpreter with class nohighlight.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about removing dotenv in the markdown?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

By removing dotenv, language it will be set to ini. This is not correct.

But we will use it temporarily. what do you think?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change to ```text.
ini is not correct, because it is not a ini file.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I sent PR #864

@datamweb datamweb marked this pull request as ready for review September 27, 2023 06:29
kenjis
kenjis previously approved these changes Sep 28, 2023
@kenjis kenjis dismissed their stale review September 28, 2023 01:06

Cannot run mkdocs

@kenjis
Copy link
Member

kenjis commented Sep 28, 2023

@datamweb How can I run mkdocs?

$ mkdocs serve
ERROR   -  Config value 'theme': Unrecognised theme name: 'material'. The available installed themes are: mkdocs, readthedocs
ERROR   -  Config value 'markdown_extensions': Failed to load extension 'pymdownx.superfences'.
           ModuleNotFoundError: No module named 'pymdownx'

Aborted with 2 configuration errors!

@kenjis
Copy link
Member

kenjis commented Sep 28, 2023

Resolved.

$ pip3 install mkdocs
$ pip3 install mkdocs-material
$ pip3 install mkdocs-git-revision-date-localized-plugin

Copy link
Member

@kenjis kenjis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@kenjis kenjis mentioned this pull request Sep 28, 2023
2 tasks
@datamweb datamweb merged commit b1adfa8 into codeigniter4:develop Sep 28, 2023
1 check passed
@datamweb datamweb deleted the improve-site-part2 branch September 28, 2023 20:46
@kenjis kenjis changed the title Improve site part2 mkdocs: Improve site part2 Oct 3, 2023
@kenjis kenjis changed the title mkdocs: Improve site part2 docs: Improve site part2 Oct 3, 2023
@kenjis kenjis changed the title docs: Improve site part2 mkdocs: Improve site part2 Oct 3, 2023
@kenjis kenjis added the enhancement New feature or request label Oct 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants