Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
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: 3 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 (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-10-03T18:11:54.000Z (4 months ago)
- Last Synced: 2024-10-30T07:34:49.678Z (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: 4.96 MB
- Stars: 11
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.pod6
- License: LICENSE
Awesome Lists containing this project
README
# Podlite-web
📖 Create static websites with Next.js and the [Podlite](https://podlite.org/) markup language!
## QUICK GUIDE
### using yarn
It is recommended to install Yarn through the npm package manager, which comes bundled with Node.js when you install it on your system.
Once you have npm installed you can run the following both to install and upgrade Yarn:
```sh
npm install --global yarn
```
and then:
```sh
yarn && yarn dev
```
- open link [http://localhost:3000](http://localhost:3000) after
Here is demo page from `pub` directory.
You can edit pub/\*.pod6 files and see changes after save.
All features like `=Mermaid`, `=picture` , `=toc` for [Podlite editor](https://github.com/podlite/podlite-desktop) are available for podlite-web as well:
### using Docker
- make `index.pod6` with the following content:
```
=begin pod
=TITLE Personal blog
🚧 Web site is under construction. 🚧
=end pod
```
run the command:
```sh
docker run -it --rm -v ${PWD}:/app/pub -p 3000:3000 podlite/podlite-web dev
```
- open link [http://localhost:3000](http://localhost:3000)
- after edit `index.pod6` web page will reload automatically
#### Export to zipped static site
```sh
docker run --rm -v ${PWD}:/app/pub podlite/podlite-web export-zip > site.zip
```
#### Advance configuration
- using `https://example.com` as domain name
- customize Time Zone
- change default `index.pod6` path to subdirectory
```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
```
## Run examples
### Run minimal site
```sh
POSTS_PATH='examples/01-minimal' yarn dev
```
### Make links between pages
```sh
POSTS_PATH='examples/02-pages' yarn dev
```
### Blog with standalone pages and Notes from Diary
This example contains integration with `React` components, customize styles and publish notes from Diary document.
```sh
POSTS_PATH='examples/03-blog' yarn dev
```
## 💻 Develop
### Setup the repo
```sh
yarn
```
### Develop
`yarn dev` will spin up the demosite from `pub` directory and watch changes to the files.
### Export to zip
```sh
yarn export-zip > file.zip
```
Explore `examples` dir for get more Podlite insights.
thank you!
## Useful links related to Podlite markup language
##### specification
- [Source](https://github.com/podlite/podlite-specs)
- [in HTML](https://podlite.org/specification)
- [Discussions](https://github.com/podlite/podlite-specs/discussions)
- [Implementation](https://github.com/podlite/podlite)
##### publishing system
- [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)
- [Issues](https://github.com/podlite/podlite-specs/issues)
##### desktop viewer/editor
- [Podlite-desktop](https://github.com/podlite/podlite-desktop)
- [Releases](https://github.com/podlite/podlite-desktop/releases)
- [Issues](https://github.com/podlite/podlite-desktop/issues)
##### online resurces
- [podlite.org](https://podlite.org)
- [pod6.in](https://pod6.in/)
- [github.com/podlite](https://github.com/podlite/)
## License
This project is licensed under the terms of the
[MIT license](/LICENSE).