Git Product home page Git Product logo

podlite-web's Introduction

Podlite-web

๐Ÿ“– Create static websites with Next.js and the Podlite 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:

npm install --global yarn

and then:

yarn && yarn dev

Here is demo page from pub directory.

Podlite-Web demo page Screenshot Podlite-Web demo page Screenshot

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

All features like =Mermaid, =picture , =toc for Podlite editor are available for podlite-web as well: Podlite editor Screenshot

using Docker

  • make index.pod6 with the following content:
=begin pod
=TITLE Personal blog

๐Ÿšง Web site is under construction. ๐Ÿšง
=end pod

run the command:

docker run -it --rm -v ${PWD}:/app/pub -p 3000:3000  podlite/podlite-web dev

Export to zipped static site

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
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

POSTS_PATH='examples/01-minimal'  yarn dev

Make links between pages

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.

POSTS_PATH='examples/03-blog'  yarn dev

๐Ÿ’ป Develop

Setup the repo

yarn

Develop

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

Export to zip

yarn export-zip > file.zip

Explore examples dir for get more Podlite insights.

thank you!

Useful links related to Podlite markup language

License

This project is licensed under the terms of the MIT license.

podlite-web's People

Contributors

zag avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.