# calliope-ssg > ![Calliope](content/media/calliope.png) Latest version **0.1.1** (published 2020-11-25) · Apache-2.0 license · 0 weekly downloads ## Install ```sh npm install calliope-ssg pnpm add calliope-ssg yarn add calliope-ssg bun add calliope-ssg ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.1.1 | | Published | 2020-11-25 | | First published | 2020-11-25 | | Weekly downloads | 0 | | License | Apache-2.0 | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 39 | | Unpacked size | 1.4 MB | | Known vulnerabilities | 0 (+8 in 2 direct dependencies) | | Install scripts | no | | GitHub stars | 3 | | Author | Kyle Derby MacInnis | | Maintainers | kderbyma | ## Links - npm: https://www.npmjs.com/package/calliope-ssg - Repository: https://github.com/ConflictingTheories/calliope - Homepage: http:/// - npm.io page: https://npm.io/package/calliope-ssg ## Dependencies (39) - [pg](https://npm.io/package/pg.md) ^8.5.1 - [cors](https://npm.io/package/cors.md) ^2.8.5 - [glob](https://npm.io/package/glob.md) ^7.1.6 - [react](https://npm.io/package/react.md) ^16.13.1 - [config](https://npm.io/package/config.md) ^3.3.2 - [mysql2](https://npm.io/package/mysql2.md) ^2.1.0 - [rsuite](https://npm.io/package/rsuite.md) ^4.8.2 - [aws-sdk](https://npm.io/package/aws-sdk.md) ^2.761.0 - [express](https://npm.io/package/express.md) ^4.17.1 - [shelljs](https://npm.io/package/shelljs.md) ^0.8.4 - [react-dom](https://npm.io/package/react-dom.md) ^16.13.1 - [sequelize](https://npm.io/package/sequelize.md) ^6.3.5 - [craco-less](https://npm.io/package/craco-less.md) ^1.17.0 - [remark-gfm](https://npm.io/package/remark-gfm.md) ^1.0.0 - [typescript](https://npm.io/package/typescript.md) ^4.0.2 - [@types/node](https://npm.io/package/@types/node.md) ^14.10.1 - [body-parser](https://npm.io/package/body-parser.md) ^1.19.0 - [react-katex](https://npm.io/package/react-katex.md) ^2.0.2 - [remark-html](https://npm.io/package/remark-html.md) ^13.0.1 - [remark-math](https://npm.io/package/remark-math.md) ^4.0.0 - [remark-slug](https://npm.io/package/remark-slug.md) ^6.0.0 - [@craco/craco](https://npm.io/package/@craco/craco.md) ^5.6.4 - [remark-emoji](https://npm.io/package/remark-emoji.md) ^2.1.0 - [@types/config](https://npm.io/package/@types/config.md) ^0.0.36 - [cookie-parser](https://npm.io/package/cookie-parser.md) ^1.4.5 - [react-scripts](https://npm.io/package/react-scripts.md) 3.4.3 - [react-markdown](https://npm.io/package/react-markdown.md) ^5.0.3 - [express-session](https://npm.io/package/express-session.md) ^1.17.1 - [react-recollect](https://npm.io/package/react-recollect.md) ^5.2.3 - [react-router-dom](https://npm.io/package/react-router-dom.md) ^5.2.0 - [@blueprintjs/core](https://npm.io/package/@blueprintjs/core.md) ^3.31.0 - [express-fileupload](https://npm.io/package/express-fileupload.md) ^1.2.0 - [@testing-library/dom](https://npm.io/package/@testing-library/dom.md) ^7.24.2 - [@fec/remark-a11y-emoji](https://npm.io/package/@fec/remark-a11y-emoji.md) ^2.0.0 - [@testing-library/react](https://npm.io/package/@testing-library/react.md) ^9.3.2 - [react-syntax-highlighter](https://npm.io/package/react-syntax-highlighter.md) ^15.3.0 - [remark-autolink-headings](https://npm.io/package/remark-autolink-headings.md) ^6.0.1 - [@testing-library/jest-dom](https://npm.io/package/@testing-library/jest-dom.md) ^4.2.4 - [@testing-library/user-event](https://npm.io/package/@testing-library/user-event.md) ^7.1.2 ## Recent versions - 0.1.1 (latest) — 2020-11-25 - 0.1.0 — 2020-11-25 ## README # Calliope Site Generator ![Calliope](content/media/calliope.png) ## What is Calliope? Calliope is a Static site generator and webserving platform. It provides two functions - static generation and live serving. The server is done to help make it quick for you to check changes locally without pushing anything out, and these sites are primarily focused at the moment on small blog and post-driven content. In the future Calliope will provide more plugins and themes (it already has two) and will hopefully begin to expand on the markdown support and provide its own form of shortcode plugins. For now, everything is read out of the `/content` directory and posts are read from markdown files found with `/content/posts`. These are rendered according to the selected theme which can configured through the `.env` file. Note that a sample has been provided, but for windows you will need to slightly adjust the script to work on Powershell -- replace `export =` with `$env:=""`. When you serve the static files, keep in mind that you will need to provide a web server (I suggest `npm install -g http-server` myself) or via a service like Netlify. If you use the server it will host it for you and make it available on your local machine. **Note** - You will need to set the variables for your system and then make sure you have them active in your shell otherwise you may find some errors. ## Static vs Served You can serve your content via NodeJS and this will read posts and content directly from the filesystem, or you can compile and bundle a static version of your site and host it using a service such as S3, Netlify, etc. _To Serve:_ yarn yarn build # Build API / Admin yarn run # Run Server _To Compile:_ yarn yarn build-static # Compile Static Assets & Manifests cd build && http-server # Serve Static files _To Deploy:_ (Coming Soon - tools to help deploy -- For Now I recommend https://netlify.com and using https://github.com) ## LICENSE Apache-2.0 --- _Source: https://npm.io/package/calliope-ssg · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._