https://github.com/mearns/npm-project-website
A tool to generate a static website for your npm project
https://github.com/mearns/npm-project-website
Last synced: about 1 month ago
JSON representation
A tool to generate a static website for your npm project
- Host: GitHub
- URL: https://github.com/mearns/npm-project-website
- Owner: mearns
- License: mit
- Created: 2021-03-22T19:16:58.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2021-04-03T01:24:50.000Z (about 4 years ago)
- Last Synced: 2025-02-05T11:45:04.675Z (3 months ago)
- Language: TypeScript
- Size: 874 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# npm-project-website
---
**This project is currently in pre-alpha stage.**
This is a tool to generate a static web site from your npm project, to show off things like your README file,
API documentation, test reports, etc.
_By [Brian Mearns](https://github.com/mearns)_
## Development
### Development Cycle
Start a dev server to serve the generated site files:
```console
$ npm run start
> [email protected] start /Users/bmearns/sandbox/personal/npm-project-website
> http-server public
Starting up http-server, serving public
Available on:
http://127.0.0.1:8080
http://192.168.1.173:8080
http://10.100.5.22:8080
Hit CTRL-C to stop the server
```
Leave that running, and in a new shell, do this to build the project and generate the static site files:
```console
$ npm run compile && npm run -s run
...
Copied logo file: public/resources/logo.png
Generated page: public/index.html
```
And view the site at http://127.0.0.1:8080/
### Build
```console
$ npm run compile
```
Will compile typescript files into `dist/` and compile the webpack bundles for each page into `public/script/$PAGE_NAME.js`.
### Generate Site
Assumes you have built the project as above.
```console
npm run run
```