obsidianmd / obsidianmd/obsidian-developer-docs
Machine-readable version of CSS Variables reference?
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 521
- Forks
- 174
- PR merge metrics
- No merged PRs in 30d
Description
I'd like to create a searchable index of all CSS properties with their categories and descriptions, and right now I'd have to pull the data straight out of the Markdown. That's not a huge obstacle, but I'm wondering if it's actually necessary.
Do the Markdown files get updated by hand (and are therefore the only source of truth for the docs), or is there some underlying data from which they are generated? If the latter, would it be feasible to expose this data as e.g. JSON?
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by inspecting the Markdown files containing the CSS properties, then determine whether they are maintained by hand or generated from another source. Clarify the desired searchable index and JSON shape with maintainers; done means an agreed source of truth and documented machine-readable output.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- css, javascript
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100