Repository navigation
Send page metadata and the renderer settings of mkdocs.yml - #82
Merged
Merged
Conversation
Documents in the tree get the front matter fields the clients show (title, description, icon, status, tags, search.exclude) and the page name as MkDocs derives it. Pins and feed entries get the title too. GET /wiki/config/ returns theme, plugins and Markdown extensions without secrets. Features "page-meta" and "wiki-config", see docs/page-meta.md. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Front matter support for the clients, requested by Android, specified in
docs/page-meta.md.Page metadata (feature
page-meta)meta: {title, description, icon, status, tags, searchExclude}from the YAML front matter.title, the page name in the MkDocs order: front mattertitle, else the first H1 (ATX or setext, outside fences), else the file name. For the file name,-/_become spaces and an all-lowercase name gets a capital first letter;index/READMEuse the folder name, and the root index isHome.titletoo.tree-changed; the message itself carries nothing new.Wiki config (feature
wiki-config)GET /wiki/config/returnssiteName,siteUrl,useDirectoryUrls,theme {name, features, palette},plugins,markdownExtensionsandextraCss. Lists are normalized from all MkDocs forms; without apluginskey the result issearchalone.!ENVvalues and keys that look like secrets (*token,*secret,*password,*apikey,key,auth, ...) are dropped at any depth, and nothing outside these keys is sent.!!python/name:xbecomesx.Live wiki
index.mdhas front matter (title: Home), none uses MultiMarkdown meta. So the backend reads YAML front matter only.mkdocs.ymlhas nopluginskey, so the defaultsearchapplies.Note
The existing
GET /mkdocs/config/still returns the wholemkdocs.ymlunfiltered to every authenticated account. I left it unchanged. Restricting or removing it is a separate decision.Tests
internal/wiki: front matter forms (BOM, CRLF,..., invalid YAML), title rules, tree cache refresh. Also the config with the live wiki's form plus secrets,!ENV, python tags, mapping plugins and defaults.internal/api: tree, a live edit reaching the title, pin and feed titles,/wiki/config/.🤖 Generated with Claude Code