From 9eabf9f665be6bbdf4a5e7337cff911391902167 Mon Sep 17 00:00:00 2001 From: Mark Ayers Date: Thu, 28 Sep 2023 12:07:47 -0400 Subject: [PATCH] Improve the config/README - copyedit - use Note callout rather than blockquote/strong text Note - mark more inline code --- config/README.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/config/README.md b/config/README.md index 5f461901..9b7ce2c0 100644 --- a/config/README.md +++ b/config/README.md @@ -1,13 +1,14 @@ # API Extractor -We generate the reference documentation for the `obsidian` TypeScript API using the [API Extractor](https://api-extractor.com/). +Using the [API Extractor](https://api-extractor.com/), we generate the reference documentation for the Obsidian TypeScript API. -> **Note**: This folder maintains unchanged copies of the following files from the [obsidianmd/obsidian-api](https://github.com/obsidianmd/obsidian-api): +> [!note] +> This folder maintains unchanged copies of the following files from the [obsidianmd/obsidian-api](https://github.com/obsidianmd/obsidian-api): > -> - obsidian.d.ts -> - package.json +> - `obsidian.d.ts` +> - `package.json` > -> To update the reference docs, you first need to sync these files with the original. To avoid maintaining copies, we should consider moving the `api-extractor.json` file to [obsidianmd/obsidian-api](https://github.com/obsidianmd/obsidian-api) and add the repository as a Git submodule for this repository. +> To update the reference docs, you must first sync these files with the original. To avoid maintaining copies, we should consider moving the `api-extractor.json` file to [obsidianmd/obsidian-api](https://github.com/obsidianmd/obsidian-api) and add the repository as a Git submodule for this repository. ## Generate docs @@ -17,13 +18,13 @@ We generate the reference documentation for the `obsidian` TypeScript API using cd config ``` -2. Generate the .api.json file. The following command generates `./input/obsidian.api.json`. +2. Generate the `.api.json` file. The following command generates `./input/obsidian.api.json`. ```bash api-extractor run --local --verbose ``` -3. Generate Markdown docs. The following command generates Markdown docs from the .api.json file. +3. Generate Markdown docs. The following command generates Markdown docs from the `.api.json` file. ```bash api-documenter markdown --output ../en/Reference/TypeScript\ API