Powerlevel10k: Question: Is there a proper documentation page?

[jolo-dev]

As much as I love Github's readmes, but doing the whole documentation within a single Readme is sort of inefficient. Especially if there is a lot.
Is there a documentation page?
If not, why not using Github Pages ;)

[romkatv]

As much as I love Github's readmes, but doing the whole documentation within a single Readme is sort of inefficient. Especially if there is a lot.

I hear you. The documentation story is pretty bad. Not only it's difficult to navigate but it also doesn't document the majority of functionality.

Is there a documentation page?

The homepage (README.md) and ~/.p10k.zsh are the only documentation pages.

If not, why not using Github Pages ;)

No particular reason.

[jolo-dev]

Have you ever thought about one?
Maybe a Sphinx could be published as a Github page, right?

[romkatv]

Have you ever thought about one?
Maybe a Sphinx could be published as a Github page, right?

Maybe.

Is this something you'd like to try?

[jolo-dev]

Yes, let me try :)
Or as an alternative, @romkatv you could enable the wiki like Oh-my-zsh did.

[romkatv]

I don't want wiki. It allows anyone to post anything and it appears authoritative.

[jolo-dev]

Okay, I see then let me try the Sphinx Documentation ;)

[romkatv]

let me try the Sphinx Documentation ;)

👍

[jolo-dev]

I had been working on a it.
https://jolo-dev.github.io/powerlevel10k/

However, the github action for CD is not working yet...

[romkatv]

Looks cool!

[jolo-dev]

Thanks!
I could do a pull request but you need to deploy it.
For some reason, the Github action with python is not working (https://github.com/actions/setup-python/issues/162).
What do you think?

[romkatv]

Give me more details. What will I need to do, when, and what effect will it have.

[jolo-dev]

I have created this with MkDocs which you need to install via pip

pip install mkdocs

Then you simply needs to run

mkdocs gh-deploy

That would create a branch gh-pages and you need to put in the settings of this repository the Github Pages to that branch.

Find more here:
https://www.mkdocs.org/user-guide/deploying-your-docs/

[romkatv]

I've played around with https://jolo-dev.github.io/powerlevel10k/. It looks nice but it's not something I would enjoy using myself. I've looked around and found this alternative to mkdocs: https://github.com/slatedocs/slate. I really like that you can use built-in search from your browser, and that the navbar automatically expands when you navigate to a section with nested headings. There is also place for code samples, which would come in handy when I finally get around to writing a reference manual for all settings.

[jolo-dev]

Absolute valid point.
Let me try slate. And will come back to you

As an alternative, I found https://docsify.js.org/ quite beautiful as well.

[romkatv]

Absolute valid point.
Let me try slate. And will come back to you

Looking forward to it!

As an alternative, I found https://docsify.js.org/ quite beautiful as well.

Does it support collapsible havbar? The examples I could find don't have this feature.

Here's what I mean. Open https://slatedocs.github.io/slate and either scroll down or click on Kittens on the left. Notice that you are still on the same page (only the fragment of the URL has changed) and that Kittens in the navbar has been expanded to show subheadings.