https://github.com/typescene/typescene.github.io
Typescene website
https://github.com/typescene/typescene.github.io
Last synced: about 1 year ago
JSON representation
Typescene website
- Host: GitHub
- URL: https://github.com/typescene/typescene.github.io
- Owner: typescene
- License: mit
- Created: 2017-03-20T16:02:07.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2023-04-18T08:00:17.000Z (about 3 years ago)
- Last Synced: 2024-03-18T10:20:32.237Z (about 2 years ago)
- Language: TypeScript
- Size: 2.48 MB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Typescene Website
This is the website served at https://typescene.dev.
### Issues and Maintenance
This site is fully managed through a Github repository. If you encounter any issues or would like to contribute an any other way, please use the Issues or Pull Request tabs.
### Content Generation
Reference documentation is generated automatically from `.d.ts` files and some additional Markdown content. The documentation generator is located in the `docgen` folder.
The source code for the search widget is included in the `docwidget` folder.
Static content is built using the [`markdown-pipeline`](https://www.npmjs.com/package/markdown-pipeline) tool, from the following sources:
* Comments and types in Typescene package `.d.ts` files, augmented with Markdown content from the `content/reference` folder. Source code for this documentation generation step is in the `docgen` folder.
* Search widget, source code in the `docwidget` folder (built separately).
* Documentation pages, Markdown content in the `content/docs` folder.
* Guides, Markdown content in the `content/guides` folder.
* Static assets in the `assets` folder.
* Home page, with content in `content/index.md` and a special template.
* 404 page, with content in `content/404.md`