search

obsidianmd / obsidian-api

Type definitions for the latest Obsidian API.
https://docs.obsidian.md
MIT License
1.71k stars 199 forks source link

feat(docs): :sparkles: add api-extractor config #127

Closed LBF38 closed 1 year ago

LBF38 commented 1 year ago

This is for the api-extractor to generate the api docs. Please see the obsidian-developer-docs repo for more info.

Refer to https://github.com/obsidianmd/obsidian-developer-docs/pull/55 for more information.

lishid commented 1 year ago

Thanks for the PR. I'm not a fan of the idea of incorporating something into this repo just to accommodate the building process of another repo. Plus the file being committed to this repo in support of the other repo only has meaning to the other repo so it's kinda confusing to anyone watching/using this repo.

I've proposed a better approach in the original PR in the docs repo where we would import the file via npm. That would allow us to better control the publishing process of new versions without automatically generating the from the latest work-in-progress definition file in this repo.