https://github.com/podlite/podlite-web
📖 Create static websites with Next.js and the Podlite markup language.
https://github.com/podlite/podlite-web
documentation documentation-generator documentation-website jamstack javascript nextjs pod6 podlite podlite-markup podlite-markup-language react static-site static-site-generation static-site-generator template typescript web web-application web-development
Last synced: about 2 months ago
JSON representation
📖 Create static websites with Next.js and the Podlite markup language.
- Host: GitHub
- URL: https://github.com/podlite/podlite-web
- Owner: podlite
- License: mit
- Created: 2022-02-20T19:26:22.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2026-03-31T21:13:55.000Z (3 months ago)
- Last Synced: 2026-04-03T04:52:49.732Z (3 months ago)
- Topics: documentation, documentation-generator, documentation-website, jamstack, javascript, nextjs, pod6, podlite, podlite-markup, podlite-markup-language, react, static-site, static-site-generation, static-site-generator, template, typescript, web, web-application, web-development
- Language: TypeScript
- Homepage:
- Size: 5.09 MB
- Stars: 12
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.podlite
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
static site generator powered by Podlite markup
## Quick Start
```sh
yarn && yarn dev
```
Open [http://localhost:3000](http://localhost:3000) — demo site from `pub` directory.
### Using Docker
```sh
docker run -it --rm -v ${PWD}:/app/pub -p 3000:3000 podlite/podlite-web dev
```
Edit `index.pod6` and the page reloads automatically.
### Export to static site
```sh
docker run --rm -v ${PWD}:/app/pub podlite/podlite-web export-zip > site.zip
```
## Screenshots
## Features
- static website generation with Next.js and Podlite markup
- live reload on file save
- embedded Podlite editor with live preview
- `=Mermaid` diagrams, `=picture` images/video, `=toc` table of contents
- `=markdown` blocks for familiar Markdown syntax
- Docker support for zero-config setup
- export to zipped static site
## Examples
```sh
# minimal site
POSTS_PATH='examples/01-minimal' yarn dev
# multi-page with links
POSTS_PATH='examples/02-pages' yarn dev
# blog with notes and React components
POSTS_PATH='examples/03-blog' yarn dev
```
## Advanced Configuration
- custom domain: `SITE_URL=https://example.com`
- timezone: `TZ=Europe/London`
- custom content path: `POSTS_PATH='path/to/content'`
```sh
cd examples/01-minimal
docker run --rm -v ${PWD}:/app/pub -p 3000:3000 \
-e 'SITE_URL=https://example.com' \
-e 'TZ=Europe/London' \
podlite/podlite-web export-zip > site.zip
```
## Develop
```sh
# install dependencies
yarn
# run dev server
yarn dev
# export to zip
yarn export-zip > file.zip
```
## Links
##### specification
- [Source](https://github.com/podlite/podlite-specs)
- [HTML](https://podlite.org/specification)
- [Discussions](https://github.com/podlite/podlite-specs/discussions)
##### implementation
- [Source](https://github.com/podlite/podlite)
- [Changelog](https://github.com/podlite/podlite/releases)
- [Issues](https://github.com/podlite/podlite/issues)
##### publishing
- [Podlite-web](https://github.com/podlite/podlite-web)
- [How-to article](https://zahatski.com/2022/8/23/1/start-you-own-blog-site-with-podlite-for-web)
- [Changelog](https://github.com/podlite/podlite-web/releases)
##### desktop editor
- [Releases](https://github.com/podlite/podlite-desktop/releases)
- [Issues](https://github.com/podlite/podlite-desktop/issues)
- Stores: [Mac](https://apps.apple.com/us/app/podlite/id1526511053) · [Windows](https://www.microsoft.com/store/apps/9NVNT9SNQJM8) · [Linux](https://snapcraft.io/podlite)
##### resources
- [podlite.org](https://podlite.org)
- [pod6.in](https://pod6.in/)
- [github.com/podlite](https://github.com/podlite/)
- [Funding](https://opencollective.com/podlite)
## Author
Copyright (c) 2022–2026 Alexandr Zahatski
## License
Released under a MIT License.