11# Podlite-web
22
3- A minimal, lightweight starter for creating blogs/sites using nexjs and pod6 markup language!
3+ A minimal, lightweight starter for creating blogs/sites using nexjs and [ Podlite ] ( https://podlite.org/ ) markup language!
44
55## QUICK GUIDE
66
7-
87### using yarn
98
109It is recommended to install Yarn through the npm package manager, which comes bundled with Node.js when you install it on your system.
@@ -14,52 +13,57 @@ Once you have npm installed you can run the following both to install and upgrad
1413``` sh
1514npm install --global yarn
1615```
17- and then:
16+
17+ and then:
18+
1819``` sh
1920yarn && yarn dev
2021```
21- * open link [ http://localhost:3000 ] ( http://localhost:3000 ) after
2222
23- Here is demo page from ` pub ` directory.
23+ - open link [ http://localhost:3000 ] ( http://localhost:3000 ) after
24+
25+ Here is demo page from ` pub ` directory.
2426
2527![ Podlite-Web demo page Screenshot] ( ./assets/demopage1.png )
2628![ Podlite-Web demo page Screenshot] ( ./assets/demopage2.png )
2729
28- You can edit pub/* .pod6 files and see changes after save.
30+ You can edit pub/\ * .pod6 files and see changes after save.
2931
30- All features like ` =Diagram ` , ` =Image ` , ` =Toc ` for [ Podlite editor] ( https://github.com/podlite/podlite-desktop ) is available for podlite-web too:
32+ All features like ` =Diagram ` , ` =Image ` , ` =Toc ` for [ Podlite editor] ( https://github.com/podlite/podlite-desktop ) is available for podlite-web too:
3133![ Podlite editor Screenshot] ( ./assets/podlite-editor.png )
3234
3335### using Docker
3436
35- * make ` index.pod6 ` with the following content:
37+ - make ` index.pod6 ` with the following content:
38+
3639```
3740=begin pod
3841=TITLE Personal blog
3942
4043🚧 Web site is under construction. 🚧
4144=end pod
4245```
46+
4347run the command:
4448
4549``` sh
4650docker run -it --rm -v ${PWD} :/app/pub -p 3000:3000 podlite/podlite-web dev
4751```
4852
49- * open link [ http://localhost:3000 ] ( http://localhost:3000 )
50- * after edit ` index.pod6 ` web page will reload automatically
51-
53+ - open link [ http://localhost:3000 ] ( http://localhost:3000 )
54+ - after edit ` index.pod6 ` web page will reload automatically
5255
5356#### Export to zipped static site
57+
5458``` sh
5559docker run --rm -v ${PWD} :/app/pub podlite/podlite-web export-zip > site.zip
5660```
5761
5862#### Advance configuration
5963
60- * using ` https://example.com ` as domain name
61- * customize Time Zone
62- * change default ` index.pod6 ` path to subdirectory
64+ - using ` https://example.com ` as domain name
65+ - customize Time Zone
66+ - change default ` index.pod6 ` path to subdirectory
6367
6468``` sh
6569cd examples/01-minimal
@@ -72,18 +76,20 @@ podlite/podlite-web export-zip > site.zip
7276## Run examples
7377
7478### Run minimal site
79+
7580``` sh
7681POSTS_PATH=' examples/01-minimal' yarn dev
7782```
7883
7984### Make links between pages
85+
8086``` sh
8187POSTS_PATH=' examples/02-pages' yarn dev
8288```
8389
8490### Blog with standalone pages and Notes from Diary
8591
86- This example contains integration with ``` React `` ` components, customize styles and publish notes from Diary document.
92+ This example contains integration with ` React ` components, customize styles and publish notes from Diary document.
8793
8894``` sh
8995POSTS_PATH=' examples/03-blog' yarn dev
101107
102108` yarn dev ` will spin up the demosite from ` pub ` directory and watch changes to the files.
103109
104- ### Export to zip
110+ ### Export to zip
105111
106112``` sh
107113yarn export-zip > file.zip
@@ -111,19 +117,15 @@ Explore `examples` dir for get more pod6 insights.
111117
112118thank you!
113119
114- Useful links
115- ------------
120+ ## Useful links
116121
117- * [ "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
118- * [ Pod6 - An easy-to-use markup language for documenting Raku modules and programs] ( https://docs.raku.org/language/pod )
119-
120- * Specification of pod6: [ Synopsis 26] ( https://github.com/perl6/specs/blob/master/S26-documentation.pod )
121-
122- * Online editor: [ https://pod6.in ] ( https://pod6.in )
123-
124- * [ Podlite] ( https://github.com/zag/podlite-desktop ) - open-source desktop pod6 editor for Windows, Linux, and Mac.
122+ - [ "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
123+ - [ Podlite is a lightweight block-based markup language designed for flexibility and ease of use.] ( https://podlite.org )
124+ - Specification of Podlite: [ podlite.org/specification] ( https://podlite.org/specification )
125+ - Online editor: [ https://pod6.in ] ( https://pod6.in )
126+ - [ Podlite Desktop] ( https://github.com/podlite/podlite-desktop ) - open-source desktop Podlite editor for Windows, Linux, and Mac.
125127
126128## License
127129
128130This project is licensed under the terms of the
129- [ MIT license] ( /LICENSE ) .
131+ [ MIT license] ( /LICENSE ) .
0 commit comments