BIMaps.io documentation homepage

Holds the contents of https://docs.bimaps.io

Reporting Issues

Please report issues to the bimaps/bimaps repo for better visibility.

Writing guides

Guides are stored in the guides/ directory and written in Markdown. Each file should contain the following header section with an appropriate title and menu order.

---
layout: 'guide'
title: 'Installation'
menuOrder: 1
---

Building the site locally

npm i
npm run build --serve

To regenerate the _site/ folder, clone modules repo in the subfolder, and then run:

cd ../modules
npm i
npm run build
node bin/typedoc --options ../typedoc.json

Creating documentation for an module

Configure files in your module.

1. package.json : add package (min. TS 3.9)

   "typescript": "^3.9.0",
   "typedoc": "^0.20.34",
   

2. .gitignore

   # Documentation
   docs
   

3. typedoc.json

   {
       "out": "docs/",
       "json": "docs/docs.json",
       "name": "BIMaps.io Documentation",
       "excludeExternals": true,
       "includeVersion": true,
       "entryPoints": ["src/index.ts"]
   }
   

4. tsconfig.json > compilerOptions (only for Aurelia projects)

   "outDir": "./dist",
   

Full documentation : Typedoc

Build you Docs

1. Run npx typedoc