Documentation for the Extollo framework, and its first-party modules.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
Garrett Mills 224568e7c5
Update homepage readme
3 weeks ago
.idea Initial import 4 weeks ago
modules Initial import 4 weeks ago
pages Add requirements to Getting-Started 4 weeks ago
static Add favicon 4 weeks ago
theme Fix Chrome styling issue 4 weeks ago
.drone.yml Improvements to Drone config 4 weeks ago
.gitignore Start custom theme 4 weeks ago
.npmrc Initial import 4 weeks ago
HOME.md Update homepage readme 3 weeks ago
LICENSE Update 'LICENSE' 4 weeks ago
README.md Update readme badge URL 4 weeks ago
package.json Add theme, pages 4 weeks ago
pagesconfig.json Add theme, pages 4 weeks ago
pnpm-lock.yaml Add theme, pages 4 weeks ago
sourcefile-map.json Add to README, generalize sourcemap rex 4 weeks ago
tsconfig.json Initial import 4 weeks ago
typedoc.json Start custom theme 4 weeks ago

README.md

docs

Build Status

Documentation for the Extollo framework, and its first-party modules.

Building the docs

API documentation is generated by TypeDoc. You can generate the documentation like so:

pnpm i
pnpm build

This will output the generated HTML site in docs/.

To remove all generated files, or reset after a failed build, run:

pnpm clean

Adding a new "Documentation" page

This site makes use of the typedoc-plugin-pages-fork package to allow custom, hand-written pages to be included in the site.

This enables us to add more beginner-friendly, or conceptual documentation to the site.

To add a new page to this group, create a markdown file in pages/ with its content. The file should follow the Pascal-Kebab case naming convention, and its name should be a short version of the title.

For example, the "Getting Started" page exists at pages/Getting-Started.md.

Now, add the file (along with its title) to the appropriate group's pages section in the pagesconfig.json file. For example:

{
  "title": "Getting Started",
  "source": "./pages/Getting-Started.md"
}