Skip to content

smalllong/lightuepress

Repository files navigation

LightuePress

npm-v npm-d brotli

Lightue and snarkdown powered static site generator

It is similar to VuePress, VitePress, Docsify. But it has the following highlights:

  • Super lightweight (<6KB min+br)
  • No compilation or server configuration needed

Usage

Create your entry html file, add CDN script and pass in your configurations:

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>Your title</title>
  </head>
  <body>
    <script src="https://unpkg.com/lightuepress@0.1.5/dist/lightuepress.min.js"></script>
    <script>
      // optionally set your default path based on user language
      if (location.hash == '') location.hash = navigator.language.slice(0, 2) == 'zh' ? '#/zh/' : '#/'
      // call Lightuepress and pass in configurations
      Lightuepress({
        // refer to this example on how to configure Lightuepress
        // https://github.com/smalllong/lightue/blob/master/docs/index.html
      })
    </script>
  </body>
</html>

Live example: https://lightue.netlify.app/