Skip to content

Commit

Permalink
Merge pull request #1 from podlite/update-202402
Browse files Browse the repository at this point in the history
Update 202402
  • Loading branch information
zag authored Feb 13, 2024
2 parents 53d577b + 4e3d1fc commit ff7f5da
Show file tree
Hide file tree
Showing 25 changed files with 902 additions and 902 deletions.
10 changes: 8 additions & 2 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
{
"arrowParens": "avoid",
"semi": false
"arrowParens": "avoid",
"semi": false,
"singleQuote": true,
"trailingComma": "all",
"endOfLine": "lf",
"tabWidth": 2,
"jsxBracketSameLine": false,
"printWidth": 120
}
4 changes: 2 additions & 2 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{
"typescript.tsdk": "node_modules/typescript/lib"
}
"typescript.tsdk": "node_modules/typescript/lib"
}
5 changes: 5 additions & 0 deletions CHANGELOG.pod6
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
=TITLE CHANGES
=head1 Upcoming
=head1 0.1.14
=item * C<=toc>, C<=markdown> are now standard blocks
=item * update dependencies
=head1 0.1.13
=item * update dependencies
=head1 0.1.12
=item * fix build error
=head1 0.1.11
Expand Down
56 changes: 29 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
# Podlite-web

A minimal, lightweight starter for creating blogs/sites using nexjs and pod6 markup language!
A minimal, lightweight starter for creating blogs/sites using nexjs and [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.
Expand All @@ -14,52 +13,57 @@ Once you have npm installed you can run the following both to install and upgrad
```sh
npm install --global yarn
```
and then:

and then:

```sh
yarn && yarn dev
```
* open link [http://localhost:3000](http://localhost:3000) after

Here is demo page from `pub` directory.
- open link [http://localhost:3000](http://localhost:3000) after

Here is demo page from `pub` directory.

![Podlite-Web demo page Screenshot](./assets/demopage1.png)
![Podlite-Web demo page Screenshot](./assets/demopage2.png)

You can edit pub/*.pod6 files and see changes after save.
You can edit pub/\*.pod6 files and see changes after save.

All features like `=Diagram`, `=Image` , `=Toc` for [Podlite editor](https://github.com/podlite/podlite-desktop) is available for podlite-web too:
All features like `=Diagram`, `=Image` , `=Toc` for [Podlite editor](https://github.com/podlite/podlite-desktop) is available for podlite-web too:
![Podlite editor Screenshot](./assets/podlite-editor.png)

### using Docker

* make `index.pod6` with the following content:
- 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

- 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
- using `https://example.com` as domain name
- customize Time Zone
- change default `index.pod6` path to subdirectory

```sh
cd examples/01-minimal
Expand All @@ -72,18 +76,20 @@ 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.
This example contains integration with `React` components, customize styles and publish notes from Diary document.

```sh
POSTS_PATH='examples/03-blog' yarn dev
Expand All @@ -101,7 +107,7 @@ yarn

`yarn dev` will spin up the demosite from `pub` directory and watch changes to the files.

### Export to zip
### Export to zip

```sh
yarn export-zip > file.zip
Expand All @@ -111,19 +117,15 @@ Explore `examples` dir for get more pod6 insights.

thank you!

Useful links
------------
## Useful links

* ["Start your own blog/site with Podlite for Web"](https://zahatski.com/2022/8/23/1/start-you-own-blog-site-with-podlite-for-web) - how-to article
* [Pod6 - An easy-to-use markup language for documenting Raku modules and programs](https://docs.raku.org/language/pod)

* Specification of pod6: [Synopsis 26](https://github.com/perl6/specs/blob/master/S26-documentation.pod)

* Online editor: [https://pod6.in](https://pod6.in)

* [Podlite](https://github.com/zag/podlite-desktop) - open-source desktop pod6 editor for Windows, Linux, and Mac.
- ["Start your own blog/site with Podlite for Web"](https://zahatski.com/2022/8/23/1/start-you-own-blog-site-with-podlite-for-web) - how-to article
- [Podlite is a lightweight block-based markup language designed for flexibility and ease of use.](https://podlite.org)
- Specification of Podlite: [podlite.org/specification](https://podlite.org/specification)
- Online editor: [https://pod6.in](https://pod6.in)
- [Podlite Desktop](https://github.com/podlite/podlite-desktop) - open-source desktop Podlite editor for Windows, Linux, and Mac.

## License

This project is licensed under the terms of the
[MIT license](/LICENSE).
[MIT license](/LICENSE).
Loading

0 comments on commit ff7f5da

Please sign in to comment.