Quick example
Prerequisites
- Have folder called "SDK IntelliSense" with subfolders and typings files (
*.d.ts
) - Create a project folder
my_project
at the same level with "SDK IntelliSense". - Use typedoc to create API documentation in
ftosapifiles
in your project folder.
# Navigate to "SDK IntelliSense" folder
# Now use these commands
mkdir my_project
cd my_project
typedoc ../"SDK IntelliSense" --mode file --out ftosapifiles --name FintechOSApi --includeDeclarations --ignoreCompilerErrors
includes
files
Step 1: Create before and after mkdir ftosapiles_includes
cd ftosapifiles_includes
echo ## Top content > index_before.md
echo ## Bottom content > index_after.md
cd ..
_before
and _after
includes
files
Step 2: Insert typedocinc build ftosapifiles --includes ftosapifiles_includes --target ftosapifiles_modified
The build
command will include the index_before.md
before the API documentation inindex.html
, and include the index_after.md
after the API documentation in index.html
Step 3: Use modified documentation
Open the ftosapifiles_modified\index.html
in your browser, and notice the content the before and after content.
Summary
You created the ftosapifiles_includes/index_before.md
and ftosapifiles_includes/index_after.md
corresponding to ftosapifiles/index.html
. Used typedocinc
's build
command to build the modified documentation in ftosapifiles_modified
.