├── .gitignore
├── demo
├── html
│ ├── logo.png
│ ├── index.html
│ ├── about.html
│ └── folder
│ │ ├── about.html
│ │ └── index.html
├── data-fragments
│ ├── site1.json
│ └── site2.json
├── template
│ ├── todos.tmpl
│ ├── user.tmpl
│ └── users.tmpl
└── site.json
├── website
├── themes
│ └── juice
│ │ ├── screenshot.png
│ │ ├── content
│ │ ├── go-search-extension.png
│ │ ├── cpp-search-extension.png
│ │ ├── rust-search-extension.png
│ │ ├── about.md
│ │ ├── changelog.md
│ │ ├── showcases.md
│ │ ├── _index.md
│ │ └── juice.svg
│ │ ├── vercel.json
│ │ ├── sass
│ │ ├── _ultility.scss
│ │ ├── _markdown.scss
│ │ ├── _text.scss
│ │ └── juice.scss
│ │ ├── theme.toml
│ │ ├── templates
│ │ ├── page.html
│ │ ├── _variables.html
│ │ ├── _macros.html
│ │ └── index.html
│ │ ├── config.toml
│ │ ├── LICENSE
│ │ ├── README.md
│ │ └── static
│ │ └── normalize.css
├── content
│ ├── message.md
│ ├── news.md
│ ├── community.md
│ └── _index.md
├── message.tmpl
├── message_list.tmpl
├── templates
│ ├── _variables.html
│ └── index.html
├── config.toml
├── stitcher.hcl
└── public
│ ├── juice.css
│ └── normalize.css
├── main.go
├── default.nix
├── shell.nix
├── stitcher
├── fragmented_page.go
├── config.go
├── signal.go
├── transform.go
├── cache.go
├── host.go
├── fragement_fetcher.go
├── server.go
├── fragment.go
└── route.go
├── flake.nix
├── go.mod
├── cmd
└── root.go
├── flake.lock
├── README.md
├── LICENSE
├── gomod2nix.toml
└── go.sum
/.gitignore:
--------------------------------------------------------------------------------
1 | /gomod2nix-template
2 |
--------------------------------------------------------------------------------
/demo/html/logo.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vhodges/stitcherd/HEAD/demo/html/logo.png
--------------------------------------------------------------------------------
/demo/data-fragments/site1.json:
--------------------------------------------------------------------------------
1 | {
2 | "site_name": "Site One From site1.json",
3 | "site_key": "foobarbaz"
4 | }
--------------------------------------------------------------------------------
/website/themes/juice/screenshot.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vhodges/stitcherd/HEAD/website/themes/juice/screenshot.png
--------------------------------------------------------------------------------
/demo/data-fragments/site2.json:
--------------------------------------------------------------------------------
1 | {
2 | "site_name": "Site Two From site2.json",
3 | "site_key": "otherfoobarbaz"
4 | }
5 |
--------------------------------------------------------------------------------
/main.go:
--------------------------------------------------------------------------------
1 | package main
2 |
3 | import (
4 | "github.com/vhodges/stitcherd/cmd"
5 | )
6 |
7 | func main() {
8 | cmd.Execute()
9 | }
10 |
--------------------------------------------------------------------------------
/website/themes/juice/content/go-search-extension.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vhodges/stitcherd/HEAD/website/themes/juice/content/go-search-extension.png
--------------------------------------------------------------------------------
/website/themes/juice/content/cpp-search-extension.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vhodges/stitcherd/HEAD/website/themes/juice/content/cpp-search-extension.png
--------------------------------------------------------------------------------
/website/themes/juice/content/rust-search-extension.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vhodges/stitcherd/HEAD/website/themes/juice/content/rust-search-extension.png
--------------------------------------------------------------------------------
/website/themes/juice/vercel.json:
--------------------------------------------------------------------------------
1 | {
2 | "build": {
3 | "env": {
4 | "ZOLA_VERSION": "0.11.0"
5 | }
6 | },
7 | "github": {
8 | "silent": true
9 | }
10 | }
--------------------------------------------------------------------------------
/website/content/message.md:
--------------------------------------------------------------------------------
1 | +++
2 | title = "Message"
3 | description = "Message"
4 | [extra]
5 | no_nav = true
6 | +++
7 |
8 |
9 | Content gets replaced at runtime
10 |
11 |
--------------------------------------------------------------------------------
/website/content/news.md:
--------------------------------------------------------------------------------
1 | +++
2 | title = "News"
3 | description = "Latest News"
4 | weight = 1
5 | +++
6 | Archives/Subscribe: stitcherd-announce
7 |
8 |
9 |
--------------------------------------------------------------------------------
/demo/template/todos.tmpl:
--------------------------------------------------------------------------------
1 |
2 | {{range .json}}
3 |
--------------------------------------------------------------------------------
/demo/template/user.tmpl:
--------------------------------------------------------------------------------
1 |
2 |
{{.json.name}}
3 |
{{.json.email}}
4 |
8 |
2 |
3 | {{ (.document.Find ".container .row:first-of-type div h3").Html }}
4 |
5 |
6 |
7 | {{ unescape (.document.Find "pre.message-body").Html }}
8 |
9 |
2 | {{range .json}}
3 |
7 | {{end}}
8 |
Archives/Subscribe: stitcherd-general
9 |
10 | Recent Threads
11 | Content Goes Here
--------------------------------------------------------------------------------
/website/themes/juice/theme.toml:
--------------------------------------------------------------------------------
1 | name = "juice"
2 | description = "An intuitive, elegant, and lightweight Zola theme for product sites."
3 | license = "MIT"
4 | homepage = "https://github.com/huhu/juice"
5 | min_version = "0.11.0"
6 | demo = "https://juice.huhu.io"
7 |
8 | [extra]
9 |
10 | [author]
11 | name = "Huhu teams"
12 | homepage = "https://huhu.io"
13 |
--------------------------------------------------------------------------------
/website/message_list.tmpl:
--------------------------------------------------------------------------------
1 |
2 | {{$elements := (.document.Find ".event-list").Children }}
3 | {{$el := $elements.First}}
4 | {{range $i, $_ := N $elements.Length }}
5 | {{ $a := $el.Find "h4 a"}}
6 | {{ $href := $a.AttrOr "href" "" }}
7 | {{ $url := urlParse $href }}
8 | {{ $label := $a.Text }}
9 |
10 |
11 |
12 | {{ $el = $el.Next}}
13 |
14 | {{end}}
15 |
8 | {{ macros::render_header() }}
9 |
10 | {% endblock header %}
11 |
12 | {% block content %}
13 | {{ page.description }}
14 | {{ page.content | safe }}
15 | {% endblock content %}
--------------------------------------------------------------------------------
/default.nix:
--------------------------------------------------------------------------------
1 | { pkgs ? (
2 | let
3 | inherit (builtins) fetchTree fromJSON readFile;
4 | inherit ((fromJSON (readFile ./flake.lock)).nodes) nixpkgs gomod2nix;
5 | in
6 | import (fetchTree nixpkgs.locked) {
7 | overlays = [
8 | (import "${fetchTree gomod2nix.locked}/overlay.nix")
9 | ];
10 | }
11 | )
12 | }:
13 |
14 | pkgs.buildGoApplication {
15 | pname = "myapp";
16 | version = "0.1";
17 | pwd = ./.;
18 | src = ./.;
19 | modules = ./gomod2nix.toml;
20 | }
21 |
--------------------------------------------------------------------------------
/shell.nix:
--------------------------------------------------------------------------------
1 | { pkgs ? (
2 | let
3 | inherit (builtins) fetchTree fromJSON readFile;
4 | inherit ((fromJSON (readFile ./flake.lock)).nodes) nixpkgs gomod2nix;
5 | in
6 | import (fetchTree nixpkgs.locked) {
7 | overlays = [
8 | (import "${fetchTree gomod2nix.locked}/overlay.nix")
9 | ];
10 | }
11 | )
12 | }:
13 |
14 | let
15 | goEnv = pkgs.mkGoEnv { pwd = ./.; };
16 | in
17 | pkgs.mkShell {
18 | packages = [
19 | goEnv
20 | pkgs.gomod2nix
21 | ];
22 | }
23 |
--------------------------------------------------------------------------------
/website/templates/_variables.html:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/website/themes/juice/templates/_variables.html:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/stitcher/fragmented_page.go:
--------------------------------------------------------------------------------
1 | package stitcher
2 |
3 | import (
4 | )
5 |
6 | // Yes, this duplicates Fragment but simplifies marshalling
7 | type FragmentedPage struct {
8 | Fragment Fragment
9 | }
10 |
11 | func (page *FragmentedPage) Render(site *Host, contextdata map[string]interface{}) string {
12 | var err error
13 | var content string = ""
14 |
15 | if page.Fragment.Cachable() {
16 | content, err = page.Fragment.FromCache(site, contextdata)
17 | if err != nil {
18 | return "" // TODO Make this better
19 | }
20 | } else {
21 | content = page.Fragment.Render(site, contextdata)
22 | }
23 |
24 | return content
25 | }
26 |
--------------------------------------------------------------------------------
/flake.nix:
--------------------------------------------------------------------------------
1 | {
2 | description = "A basic gomod2nix flake";
3 |
4 | inputs.nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
5 | inputs.flake-utils.url = "github:numtide/flake-utils";
6 | inputs.gomod2nix.url = "github:nix-community/gomod2nix";
7 |
8 | outputs = { self, nixpkgs, flake-utils, gomod2nix }:
9 | (flake-utils.lib.eachDefaultSystem
10 | (system:
11 | let
12 | pkgs = import nixpkgs {
13 | inherit system;
14 | overlays = [ gomod2nix.overlays.default ];
15 | };
16 |
17 | in
18 | {
19 | packages.default = pkgs.callPackage ./. { };
20 | devShells.default = import ./shell.nix { inherit pkgs; };
21 | })
22 | );
23 | }
24 |
--------------------------------------------------------------------------------
/stitcher/config.go:
--------------------------------------------------------------------------------
1 | package stitcher
2 |
3 | import (
4 | "encoding/json"
5 | "io/ioutil"
6 | "log"
7 | )
8 |
9 | func ReadHostConfigFile(filename string) (c *Host, err error) {
10 |
11 | content, err := ioutil.ReadFile(filename)
12 | if err != nil {
13 | return nil, err
14 | }
15 |
16 | // TODO Unmarshall JSON into Host struct pointer
17 | var host Host
18 | json.Unmarshal([]byte(content), &host)
19 |
20 | return &host, nil
21 | }
22 |
23 | func NewHostFromFile(file string) (*Host, error) {
24 |
25 | host, err := ReadHostConfigFile(file)
26 |
27 | if err != nil {
28 | log.Printf("Error reading config file '%s': %v", file, err)
29 | return nil, err
30 | }
31 |
32 | host.Init()
33 |
34 | return host, nil
35 | }
36 |
--------------------------------------------------------------------------------
/website/themes/juice/templates/_macros.html:
--------------------------------------------------------------------------------
1 | {% macro render_header() %}
2 | {% set section = get_section(path="_index.md") %}
3 |
4 |
5 | {{ config.extra.juice_logo_name }}
6 |
7 |
8 |
9 |
10 | {% for p in section.pages %}
11 | {% if p.extra.no_nav is undefined %}
12 | {{ p.title }}
13 | {% endif %}
14 | {% endfor %}
15 | {% if config.extra.juice_extra_menu %}
16 | {% for menu in config.extra.juice_extra_menu %}
17 | {{ menu.title }}
18 | {% endfor %}
19 | {% endif %}
20 |
21 | {% endmacro render_header %}
--------------------------------------------------------------------------------
/website/themes/juice/config.toml:
--------------------------------------------------------------------------------
1 | # The URL the site will be built for
2 | base_url = "/"
3 |
4 | title = "Juice - An intuitive, elegant, and lightweight Zola theme for product sites."
5 |
6 | # Whether to automatically compile all Sass files in the sass directory
7 | compile_sass = true
8 |
9 | # Whether to do syntax highlighting
10 | # Theme can be customised by setting the `highlight_theme` variable to a theme supported by Zola
11 | highlight_code = true
12 | highlight_theme = "inspired-github"
13 |
14 | # Whether to build a search index to be used later on by a JavaScript library
15 | build_search_index = false
16 |
17 | [extra]
18 | juice_logo_name = "Stitcherd"
19 | juice_logo_path = "logo.png"
20 | juice_extra_menu = [
21 | { title = "Github", link = "https://github.com/huhu/juice" }
22 | ]
--------------------------------------------------------------------------------
/website/themes/juice/content/about.md:
--------------------------------------------------------------------------------
1 | +++
2 | title = "About"
3 | description = "About"
4 | weight = 3
5 | +++
6 |
7 | # Juice
8 |
9 | **Juice** is an intuitive, elegant, and responsive Zola theme for product sites.
10 | Built by [Huhu.io](https://huhu.io), adopted by a several product sites.
11 |
12 | # Logo
13 |
14 | 
15 |
16 | # Zola
17 |
18 | [Zola](https://www.getzola.org) is a fast static site generator in a single binary with everything built-in.
19 |
20 |
21 | # Huhu.io
22 |
23 | [Huhu.io](https://huhu.io) is a global community of coders dedicated to making cool stuff coders need and want.
24 | We focus on enabling the developer community by curating, incubating, and launching tools based on great ideas,
25 | providing support and funding that allows our engineers to develop what they want, the way they want.
26 |
--------------------------------------------------------------------------------
/website/config.toml:
--------------------------------------------------------------------------------
1 | # The URL the site will be built for
2 | base_url = "https://stitcherd.vhodges.dev"
3 |
4 | # Whether to automatically compile all Sass files in the sass directory
5 | compile_sass = true
6 |
7 | # Whether to do syntax highlighting
8 | # Theme can be customised by setting the `highlight_theme` variable to a theme supported by Zola
9 | highlight_code = false
10 |
11 | # Whether to build a search index to be used later on by a JavaScript library
12 | build_search_index = false
13 |
14 | theme = "juice"
15 |
16 | [extra]
17 | # Put all your custom variables here
18 | juice_logo_name = "Stitcherd"
19 | juice_logo_path = "logo.png"
20 | juice_extra_menu = [
21 | { title = "Mailing List", link = "https://lists.sr.ht/~vhodges/stitcherd-general/" },
22 | { title = "Github", link = "https://github.com/vhodges/stitcherd" },
23 | ]
24 |
--------------------------------------------------------------------------------
/website/themes/juice/sass/_markdown.scss:
--------------------------------------------------------------------------------
1 | .content {
2 | padding: 0 40px;
3 | display: flex;
4 | flex-direction: column;
5 | justify-content: center;
6 | overflow-x: auto;
7 | }
8 |
9 | .content pre {
10 | overflow-x: auto;
11 | padding: 1.25em 1.5em;
12 | white-space: pre;
13 | word-wrap: normal;
14 | background-color: white;
15 | color: #4a4a4a;
16 | font-size: .875em;
17 | font-family: monospace;
18 | }
19 |
20 | .content code {
21 | background-color: white;
22 | color: #4a4a4a;
23 | font-size: .875em;
24 | font-weight: normal;
25 | padding: 0.25em 0.5em 0.25em;
26 | font-family: monospace;
27 | }
28 |
29 | .content a {
30 | color: var(--primary-link-color);
31 |
32 | &:hover {
33 | text-decoration: underline;
34 | }
35 | }
36 |
37 | .content blockquote {
38 | border-left: #e2dede 8px solid;
39 | margin: 0;
40 | background-color: #ececec;
41 | padding: 0 20px;
42 | }
--------------------------------------------------------------------------------
/go.mod:
--------------------------------------------------------------------------------
1 | module github.com/vhodges/stitcherd
2 |
3 | go 1.12
4 |
5 | require (
6 | github.com/Masterminds/goutils v1.1.0 // indirect
7 | github.com/Masterminds/semver v1.5.0 // indirect
8 | github.com/Masterminds/sprig v2.22.0+incompatible
9 | github.com/PuerkitoBio/goquery v1.5.1
10 | github.com/bradfitz/iter v0.0.0-20191230175014-e8f45d346db8
11 | github.com/google/uuid v1.1.2
12 | github.com/gorilla/handlers v1.5.1
13 | github.com/gorilla/mux v1.8.0
14 | github.com/huandu/xstrings v1.3.2 // indirect
15 | github.com/imdario/mergo v0.3.11 // indirect
16 | github.com/mailgun/groupcache/v2 v2.2.0
17 | github.com/mitchellh/copystructure v1.0.0 // indirect
18 | github.com/mitchellh/go-homedir v1.1.0
19 | github.com/spf13/cobra v1.1.1
20 | github.com/spf13/viper v1.7.1
21 | github.com/valyala/fasttemplate v1.2.1
22 | github.com/x-way/crawlerdetect v0.2.7
23 | golang.org/x/time v0.0.0-20190308202827-9d24e82272b4
24 | )
25 |
--------------------------------------------------------------------------------
/demo/html/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 | Simple Sticherd Demo Site
5 |
6 |
7 |
8 | Simple Stitcherd Demo Site
9 | Home -
10 | Folder -
11 | About -
12 | Users
13 |
14 |
15 |
Demo Home Page
16 |
This is a small demo of what stitcherd does and how it does it.
17 |
18 | Home - Static content
19 | Folder - A rewritten index page in a subfolder
20 | About - A rewritten html page in a subfolder
21 | Users - Richer Go template Demo with multiple JSON data requests
22 |
23 |
Ye Olde Careersite Demo
5 |
6 |
7 |
8 | Simple Stictherd Demo Site
9 | Home -
10 | Folder -
11 | About -
12 | Users
13 |
14 |
15 | About Page (in a sub-folder)
16 |
17 |
18 |
19 |
This is a small demo of what stitcherd does and how it does it.
20 |
21 | Home - Static content
22 | Jobs - Scaped content injection
23 | Todos - Simple Go Template Demo with JSON data
24 | Users - Richer Go template Demo with multiple JSON data requests
25 |
26 |
Simple Stitcher Demo Site
5 |
6 |
7 |
8 | Simple Stitcherd Demo Site
9 | Home -
10 | Folder -
11 | About -
12 | Users
13 |
14 |
15 | About Page (in a sub-folder)
16 |
17 |
18 |
19 |
This is a small demo of what stitcherd does and how it does it.
20 |
21 | Home - Static content
22 | Jobs - Scaped content injection
23 | Todos - Simple Go Template Demo with JSON data
24 | Users - Richer Go template Demo with multiple JSON data requests
25 |
26 |
Simple Stitcher Demo Site
5 |
6 |
7 |
8 | Simple Stitcherd Demo Site
9 | Home -
10 | Folder -
11 | About -
12 | Users
13 |
14 |
15 | An index page in a sub-folder
16 |
17 |
18 |
19 |
This is a small demo of what stitcherd does and how it does it.
20 |
21 | Home - Static content
22 | Jobs - Scaped content injection
23 | Todos - Simple Go Template Demo with JSON data
24 | Users - Richer Go template Demo with multiple JSON data requests
25 |
26 |
6 |
7 | Dynamic content for mostly static sites
8 |
9 |
10 | Stitcherd can automatically modify the element tree of a page before serving it to users. You can tell it where to insert new content using CSS selectors.
12 |
18 |
19 |
23 | Explore More ⇩
24 |
25 |
39 |
40 | {% endblock hero %}
41 |
42 | {% block footer %}
43 |
48 | {% endblock footer %}
49 |
--------------------------------------------------------------------------------
/cmd/root.go:
--------------------------------------------------------------------------------
1 | package cmd
2 |
3 | import (
4 | "fmt"
5 | "os"
6 |
7 | "github.com/google/uuid"
8 |
9 | homedir "github.com/mitchellh/go-homedir"
10 | "github.com/spf13/cobra"
11 | "github.com/spf13/viper"
12 | "github.com/vhodges/stitcherd/stitcher"
13 | )
14 |
15 | var (
16 | // Used for flags.
17 | cfgFile string
18 | hostConfigFiles []string
19 | listenAddress string
20 | adminHostname string
21 | workingDirectory string
22 | adminEnabled bool
23 |
24 | rootCmd = &cobra.Command{
25 | Use: "stitcherd",
26 | Short: "Site composition server",
27 | Long: `Stitcherd uses css selectors to retrieve and replace
28 | elements in an HTML document allowing site architects to compose
29 | their site from a number of different and disparate parts.`,
30 | }
31 |
32 | serverCmd = &cobra.Command{
33 | Use: "serve",
34 | Short: "Serve the one or more websites",
35 | Long: `Server one or more websites configured with a --host.hcl`,
36 | Run: func(cmd *cobra.Command, args []string) {
37 | if adminHostname == "" {
38 | adminHostname = uuid.New().String()
39 | }
40 | server := &stitcher.Stitcherd{
41 | ListenAddress: listenAddress,
42 | WorkingDirectory: workingDirectory,
43 | AdminHostName: adminHostname,
44 | AdminEnabled: adminEnabled,
45 | }
46 |
47 | server.Init().Run(hostConfigFiles)
48 | },
49 | }
50 | )
51 |
52 | // Execute executes the root command.
53 | func Execute() error {
54 | return rootCmd.Execute()
55 | }
56 |
57 | func init() {
58 | cobra.OnInitialize(initConfig)
59 |
60 | rootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "config file (default is $HOME/.cobra.yaml)")
61 | rootCmd.PersistentFlags().StringSliceVarP(&hostConfigFiles, "host", "", []string{}, "")
62 |
63 | serverCmd.Flags().StringVar(&listenAddress, "listen", "0.0.0.0:3000", "Address the server should listen on")
64 | serverCmd.Flags().StringVar(&adminHostname, "adminhost", "", "Hostname to use for the admin end point. If blank will use a secure UUID")
65 | serverCmd.Flags().StringVar(&workingDirectory, "workingdir", ".", "Workding directory for site files. Defaults to .")
66 | serverCmd.Flags().BoolVar(&adminEnabled, "enable-admin", false, "Enable Admin/API enpoint(s)")
67 |
68 | rootCmd.AddCommand(serverCmd)
69 | }
70 |
71 | func er(msg interface{}) {
72 | fmt.Println("Error:", msg)
73 | os.Exit(1)
74 | }
75 |
76 | func initConfig() {
77 | if cfgFile != "" {
78 | // Use config file from the flag.
79 | viper.SetConfigFile(cfgFile)
80 | } else {
81 | // Find home directory.
82 | home, err := homedir.Dir()
83 | if err != nil {
84 | er(err)
85 | }
86 |
87 | // Search config in home directory with name ".cobra" (without extension).
88 | viper.AddConfigPath(home)
89 | viper.SetConfigName(".cobra")
90 | }
91 |
92 | viper.AutomaticEnv()
93 |
94 | if err := viper.ReadInConfig(); err == nil {
95 | fmt.Println("Using config file:", viper.ConfigFileUsed())
96 | }
97 | }
98 |
--------------------------------------------------------------------------------
/website/themes/juice/README.md:
--------------------------------------------------------------------------------
1 | # Juice
2 |
3 |
45 | Your cool hero html...
46 |
47 | {% endblock hero %}
48 | ```
49 |
50 | ### Page
51 |
52 | Every markdown file located in `content` directory will become a **Page**. There also will display as
53 | a navigate link on the top-right corner.
54 | You can change the frontmatter's `weight` value to sort the order (ascending order).
55 |
56 | ```
57 | +++
58 | title = "Changelog"
59 | description = "Changelog"
60 | weight = 2
61 | +++
62 |
63 | ```
64 |
65 | ### CSS variables
66 |
67 | You can override theme variable by creating a file named `_variables.html` in your `templates` directory.
68 |
69 | ```html
70 |
85 | ```
86 |
87 | # Configuration
88 |
89 | You can customize some builtin property in `config.toml` file:
90 |
91 | ```toml
92 | [extra]
93 | juice_logo_name = "Juice"
94 | juice_logo_path = "juice.svg"
95 | juice_extra_menu = [
96 | { title = "Github", link = "https://github.com/huhu/juice"}
97 | ]
98 | ```
99 |
100 | # Showcases
101 |
102 | Please see the [showcases page](/showcases).
103 |
104 | # Contributing
105 |
106 | Thank you very much for considering contributing to this project!
107 |
108 | We appreciate any form of contribution:
109 |
110 | - New issues (feature requests, bug reports, questions, ideas, ...)
111 | - Pull requests (documentation improvements, code improvements, new features, ...)
--------------------------------------------------------------------------------
/website/themes/juice/content/_index.md:
--------------------------------------------------------------------------------
1 | +++
2 | title = "Juice"
3 | sort_by = "weight"
4 | +++
5 |
6 | # Juice
7 |
8 | **Juice** is an intuitive, elegant, and responsive Zola theme for product sites.
9 |
10 | - Build for product sites
11 | - Simple and intuitive structure
12 | - Clean and elegant design
13 | - Responsive and mobile device compatible
14 | - Customize and extend friendly
15 |
16 | # Installation
17 |
18 | > **Zola** is a prerequisite. Please refer to the [Zola installation](https://www.getzola.org/documentation/getting-started/installation/) docs.
19 |
20 | First download this theme to your `themes` directory:
21 |
22 | ```bash
23 | $ cd themes
24 | $ git clone https://github.com/huhu/juice.git
25 | ```
26 |
27 | or add as a submodule
28 | ```bash
29 | $ git submodule add https://github.com/huhu/juice themes/juice
30 | ```
31 |
32 | and then enable it in your `config.toml`:
33 |
34 | ```toml
35 | theme = "juice"
36 | ```
37 |
38 | # Structure
39 |
40 | ### Hero
41 |
42 | **Juice** is designed for product websites, hence we let **hero** part fills whole of screen.
43 | You can customize your **hero** by using `hero` block in the `index.html`.
44 |
45 | ```html
46 | {% block hero %}
47 |
48 | Your cool hero html...
49 |
50 | {% endblock hero %}
51 | ```
52 |
53 | ### Page
54 |
55 | Every markdown file located in `content` directory will become a **Page**. There also will display as
56 | a navigate link on the top-right corner.
57 | You can change the frontmatter's `weight` value to sort the order (ascending order).
58 |
59 | ```
60 | +++
61 | title = "Changelog"
62 | description = "Changelog"
63 | weight = 2
64 | +++
65 |
66 | ```
67 |
68 | ### CSS variables
69 |
70 | You can override theme variable by creating a file named `_variables.html` in your `templates` directory.
71 |
72 | ```html
73 |
88 | ```
89 |
90 | # Configuration
91 |
92 | You can customize some builtin property in `config.toml` file:
93 |
94 | ```toml
95 | [extra]
96 | juice_logo_name = "Juice"
97 | juice_logo_path = "juice.svg"
98 | juice_extra_menu = [
99 | { title = "Github", link = "https://github.com/huhu/juice"}
100 | ]
101 | ```
102 |
103 | # Showcases
104 |
105 | Please see the [showcases page](/showcases).
106 |
107 | # Contributing
108 |
109 | Thank you very much for considering contributing to this project!
110 |
111 | We appreciate any form of contribution:
112 |
113 | - New issues (feature requests, bug reports, questions, ideas, ...)
114 | - Pull requests (documentation improvements, code improvements, new features, ...)
115 |
--------------------------------------------------------------------------------
/website/themes/juice/templates/index.html:
--------------------------------------------------------------------------------
1 | {% import "_macros.html" as macros %}
2 |
3 |
4 |
5 |
6 | {% block title %}{{ config.title }}{% endblock title %}
8 |
22 | {{ macros::render_header() }}
23 |
24 |
25 |
26 | {% block hero %}
27 |
28 |
29 |
30 | Build your static website
31 |
32 |
33 | Juice is an intuitive, elegant, and lightweight Zola theme for product websites.
34 |
35 |
41 |
42 |
43 |
44 |
46 | Explore More ⇩
47 |
48 |
62 | {% endblock hero %}
63 |
68 |
69 | {% block content %}
70 |
Overview
71 | {{ section.content | safe }}
72 | {% endblock content %}
73 |
76 |
77 | {% block footer %}
78 |
83 | {% endblock footer %}
84 |
85 |
--------------------------------------------------------------------------------
/website/public/juice.css:
--------------------------------------------------------------------------------
1 | .text-center{text-align:center}.pos-absolute{right:0;left:0;position:absolute}.box-shadow{box-shadow:0 2px 10px 2px #ddd}.heading-text{font-family:"Fira Sans", sans-serif;font-size:32px;font-weight:600;padding:10px 0 25px 0;color:var(--primary-text-color)}h1,.title-text{font-family:"Fira Sans", sans-serif;font-size:25px;font-weight:500;color:var(--primary-text-color);border-left:var(--primary-color) 8px solid;padding-left:10px}h2,.subtitle-text{font-family:"Fira Sans", sans-serif;font-size:20px;font-weight:500;color:var(--primary-text-color)}.text{font-family:"Fira Sans", sans-serif;font-size:18px;font-weight:400;line-height:26px;letter-spacing:0.2px;color:var(--primary-text-color)}.subtext{font-family:"Fira Sans", sans-serif;font-size:16px;font-weight:400;letter-spacing:0.1px}.content{padding:0 40px;display:flex;flex-direction:column;justify-content:center;overflow-x:auto}.content pre{overflow-x:auto;padding:1.25em 1.5em;white-space:pre;word-wrap:normal;background-color:white;color:#4a4a4a;font-size:.875em;font-family:monospace}.content code{background-color:white;color:#4a4a4a;font-size:.875em;font-weight:normal;padding:0.25em 0.5em 0.25em;font-family:monospace}.content a{color:var(--primary-link-color)}.content a:hover{text-decoration:underline}.content blockquote{border-left:#e2dede 8px solid;margin:0;background-color:#ececec;padding:0 20px}body{padding:0;margin:0;box-sizing:border-box;background-color:var(--secondary-color)}a{text-decoration:none}ul{margin-top:0.5rem}ul>li{padding:0.3rem 0}p>img{width:100%;height:auto}header{background-color:var(--primary-color);color:black;padding:20px 50px;display:flex;align-items:center;justify-content:space-between}.logo{font-family:"Alfa Slab One", serif;font-size:32px;color:var(--primary-text-color);display:flex;align-items:center;margin:0 40px}.logo img{width:60px;margin:0 25px}.nav-item{margin:0 10px;text-decoration:none;font-size:18px;font-weight:bold}.nav-item:hover{color:#000;text-decoration:underline}.hero{display:flex;align-items:center;justify-content:space-evenly;height:100vh;background-color:var(--primary-color);overflow-x:hidden;padding:0 40px}.hero .explore-more{position:absolute;bottom:20px;left:45%;cursor:pointer}main{display:flex;padding:50px 100px}main .toc{max-width:260px;min-width:240px}main .toc-item{padding:10px 20px;color:#424242}main .toc-item a,main .toc-item-child a{color:var(--secondary-text-color)}main .toc-item a:hover,main .toc-item-child a:hover{cursor:pointer;text-decoration:underline}main .toc-item a.active,main .toc-item-child a.active{color:var(--toc-highlight-text-color)}main .toc-item-child{padding:0 30px 5px;color:#424242}.toc-sticky{border-radius:3px;border-top:5px solid var(--primary-color);background-color:white;position:sticky;position:-webkit-sticky;position:-moz-sticky;position:-ms-sticky;position:-o-sticky;top:10px;padding:10px 0}footer{padding:50px;display:flex;flex-direction:column;justify-content:center;align-items:center;background-color:#202020;color:#fcfcfc}footer a{color:#fcfcfc;text-decoration:underline}@media screen and (max-width: 768px){header{padding:10px 30px;flex-direction:column;align-items:center;justify-content:center}.logo{font-size:28px;margin:10px}.logo img{width:45px;margin:0 10px 0 0}.nav-item{margin:0 5px;font-size:14px}.hero{padding:40px 30px}main{padding:30px}.content{padding:0}.explore-more,.toc{display:none}}
2 |
--------------------------------------------------------------------------------
/flake.lock:
--------------------------------------------------------------------------------
1 | {
2 | "nodes": {
3 | "flake-utils": {
4 | "inputs": {
5 | "systems": "systems"
6 | },
7 | "locked": {
8 | "lastModified": 1681202837,
9 | "narHash": "sha256-H+Rh19JDwRtpVPAWp64F+rlEtxUWBAQW28eAi3SRSzg=",
10 | "owner": "numtide",
11 | "repo": "flake-utils",
12 | "rev": "cfacdce06f30d2b68473a46042957675eebb3401",
13 | "type": "github"
14 | },
15 | "original": {
16 | "owner": "numtide",
17 | "repo": "flake-utils",
18 | "type": "github"
19 | }
20 | },
21 | "gomod2nix": {
22 | "inputs": {
23 | "nixpkgs": "nixpkgs",
24 | "utils": "utils"
25 | },
26 | "locked": {
27 | "lastModified": 1677459247,
28 | "narHash": "sha256-JbakfAiPYmCCV224yAMq/XO0udN5coWv/oazblMKdoY=",
29 | "owner": "nix-community",
30 | "repo": "gomod2nix",
31 | "rev": "3cbf3a51fe32e2f57af4c52744e7228bab22983d",
32 | "type": "github"
33 | },
34 | "original": {
35 | "owner": "nix-community",
36 | "repo": "gomod2nix",
37 | "type": "github"
38 | }
39 | },
40 | "nixpkgs": {
41 | "locked": {
42 | "lastModified": 1658285632,
43 | "narHash": "sha256-zRS5S/hoeDGUbO+L95wXG9vJNwsSYcl93XiD0HQBXLk=",
44 | "owner": "NixOS",
45 | "repo": "nixpkgs",
46 | "rev": "5342fc6fb59d0595d26883c3cadff16ce58e44f3",
47 | "type": "github"
48 | },
49 | "original": {
50 | "owner": "NixOS",
51 | "ref": "master",
52 | "repo": "nixpkgs",
53 | "type": "github"
54 | }
55 | },
56 | "nixpkgs_2": {
57 | "locked": {
58 | "lastModified": 1682526928,
59 | "narHash": "sha256-2cKh4O6t1rQ8Ok+v16URynmb0rV7oZPEbXkU0owNLQs=",
60 | "owner": "NixOS",
61 | "repo": "nixpkgs",
62 | "rev": "d6b863fd9b7bb962e6f9fdf292419a775e772891",
63 | "type": "github"
64 | },
65 | "original": {
66 | "owner": "NixOS",
67 | "ref": "nixos-unstable",
68 | "repo": "nixpkgs",
69 | "type": "github"
70 | }
71 | },
72 | "root": {
73 | "inputs": {
74 | "flake-utils": "flake-utils",
75 | "gomod2nix": "gomod2nix",
76 | "nixpkgs": "nixpkgs_2"
77 | }
78 | },
79 | "systems": {
80 | "locked": {
81 | "lastModified": 1681028828,
82 | "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=",
83 | "owner": "nix-systems",
84 | "repo": "default",
85 | "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e",
86 | "type": "github"
87 | },
88 | "original": {
89 | "owner": "nix-systems",
90 | "repo": "default",
91 | "type": "github"
92 | }
93 | },
94 | "utils": {
95 | "locked": {
96 | "lastModified": 1653893745,
97 | "narHash": "sha256-0jntwV3Z8//YwuOjzhV2sgJJPt+HY6KhU7VZUL0fKZQ=",
98 | "owner": "numtide",
99 | "repo": "flake-utils",
100 | "rev": "1ed9fb1935d260de5fe1c2f7ee0ebaae17ed2fa1",
101 | "type": "github"
102 | },
103 | "original": {
104 | "owner": "numtide",
105 | "repo": "flake-utils",
106 | "type": "github"
107 | }
108 | }
109 | },
110 | "root": "root",
111 | "version": 7
112 | }
113 |
--------------------------------------------------------------------------------
/stitcher/fragement_fetcher.go:
--------------------------------------------------------------------------------
1 | package stitcher
2 |
3 | import (
4 | "bytes"
5 | "encoding/json"
6 | "fmt"
7 | "html/template"
8 | "io/ioutil"
9 |
10 | // "log"
11 | "net/http"
12 | "strings"
13 |
14 | "github.com/Masterminds/sprig"
15 | "github.com/PuerkitoBio/goquery"
16 | "github.com/bradfitz/iter"
17 | "github.com/valyala/fasttemplate"
18 | )
19 |
20 | type FragmentFetcher struct {
21 | Type string
22 |
23 | Source string // Filepath, URI, static/interpolated string, Cachekey name (For rendered)
24 |
25 | Template string // Go template name/path
26 | IsJson bool // Parse fetched fragment as JSON, Only useful if Template is present.
27 |
28 | // Values suitable for URI sources
29 | URIVerb string // GET POST PATCH DELETE(?) etc
30 | URIParams map[string]string // Post and Get will be different
31 | Headers map[string]string // Makes sense for remote fragments
32 | }
33 |
34 | func (fetcher *FragmentFetcher) Fetch(contextdata map[string]interface{}) (string, error) {
35 |
36 | t := fasttemplate.New(fetcher.Source, "{{", "}}")
37 | src := t.ExecuteString(contextdata)
38 |
39 | var fetched_fragment string = src // Default to String source
40 | var err error = nil
41 |
42 | switch fetcher.Type {
43 | case "uri":
44 | fetched_fragment, err = fetcher.FetchURI(src)
45 | case "file":
46 | fetched_fragment, err = fetcher.FetchFile(src)
47 | }
48 |
49 | if fetcher.Template != "" {
50 | templateBytes, _ := ioutil.ReadFile(fetcher.Template)
51 | templateContents := string(templateBytes)
52 |
53 | funcs := sprig.GenericFuncMap()
54 | funcs["N"] = iter.N
55 | funcs["unescape"] = unescape
56 |
57 | parsedTemplate := template.Must(template.New(fetcher.Template).Funcs(template.FuncMap(funcs)).Parse(templateContents))
58 |
59 | var buffer bytes.Buffer
60 | var data = make(map[string]interface{})
61 |
62 | if fetcher.IsJson {
63 | var jsonData interface{}
64 |
65 | json.Unmarshal([]byte(fetched_fragment), &jsonData)
66 |
67 | data["json"] = jsonData
68 | } else {
69 | var doc *goquery.Document
70 | doc, err = goquery.NewDocumentFromReader(strings.NewReader(fetched_fragment))
71 | data["document"] = doc // Add the Dom tree to the data for the template
72 | }
73 |
74 | err = parsedTemplate.Execute(&buffer, data)
75 |
76 | if err != nil {
77 | return "", err
78 | }
79 |
80 | return buffer.String(), nil
81 | }
82 |
83 | return fetched_fragment, nil
84 | }
85 |
86 | func (fetcher *FragmentFetcher) FetchURI(src string) (string, error) {
87 |
88 | // TODO At somepoint we'll probably need finer grained control over the client/request
89 | // not to mention cookie/session handling
90 | res, err := http.Get(src)
91 |
92 | if err != nil {
93 | return "", err
94 | }
95 |
96 | defer res.Body.Close()
97 |
98 | if res.StatusCode != 200 {
99 | return "", fmt.Errorf("status code error: %d %s", res.StatusCode, res.Status)
100 | }
101 |
102 | // Will need to handle/follow redirects - might be an option on the http client
103 |
104 | b, err2 := ioutil.ReadAll(res.Body)
105 | return string(b), err2
106 | }
107 |
108 | func (fetcher *FragmentFetcher) FetchFile(src string) (string, error) {
109 | b, err := ioutil.ReadFile(src)
110 | return string(b), err
111 | }
112 |
113 | func unescape(s string) template.HTML {
114 | return template.HTML(s)
115 | }
116 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Introduction
2 |
3 | Static sites are great. They're fast to serve, there's less to to go wrong and are hostable
4 | pretty much anywhere and any how you would like to. But sometimes, just sometimes there is
5 | some page or some part of every page that has dynamic or even personalized content on it.
6 | Stitcherd is for those times.
7 |
8 | It is a web server that reads some source content (typically a local static file, but could come from a remote source), fetches one or more pieces of remote “dynamic” content and injects them into the source document using a css selector to find the insertion point. These can be nested. The remote dynamic content can be remote html or output of a Go template that can also process remote html and/or remote json data.
9 |
10 | The resulting content is then served to the client. You can have multiple routes with different sets of content to be replaced (and indeed source document). In other words it does server side includes, but with css/dom manipulation and so doesn’t require special directives in the source documents.
11 |
12 | A couple of Use cases:
13 |
14 | * Fast e-commerce site with static product pages, but dynamic pricing/availability/promotions. Plus server side carts
15 | * Commenting system for static blogs. JS Free
16 | * Micro services/frontends
17 |
18 | Yes, it’s server that has to be hosted somewhere and you need to decide if that’s okay for your use case or not, but then so are most of the alternatives, except JS of course, but same-origin, et al leads it to be harder (imo) to use than this.
19 |
20 | ## Features
21 |
22 | ### Current
23 |
24 | * Multiple vhosts
25 | * CSS Selector page assembly
26 | * Static Content catch all (but... will allow proxy fallback soon)
27 | * Simple cache controls per endpoint/route (more types coming soon - ie etag, last modified etc.)
28 | * Go templates (with HTML and JSON Data retrieval) for endpoints
29 | * Bot detection (>800 known bots)
30 | * Both General and (Bot == true) rate limiting (per route)
31 | * Static content routes
32 |
33 | ### Coming Soon
34 |
35 | * (Optional) Sessions
36 | * Site Authentication (OAUTH/SAML end point config, basic auth? Builtin user/password (agencies?)). Authenticate routes?
37 | * HMAC auth support for backend ends
38 | * More control over endpoint request (ACTION/Verb, protocol, headers, cookies, form vars, etc )
39 | * Proxy for fallback (eg / to some CMS) and for routes (eg /blog/ proxied to Wordpress)
40 |
41 |
42 | # Building
43 |
44 | Requires Go > 1.12
45 |
46 | Clone the repo and then a simple
47 |
48 | ```
49 | go build
50 | ```
51 |
52 | Docker image at some point
53 |
54 | # Examples
55 |
56 | There is a 'demo' folder that serves as an example/testbed
57 |
58 | ```
59 | ./stitcherd --host demo/site.json
60 | http://localhost:3000/
61 | ```
62 |
63 | # Prior Art and Inspiration
64 |
65 | * Edge side includes (ESI) using Varnish https://varnish-cache.org/
66 | * shtml files and virtual paths in nginx
67 | * Greasemonkey: https://addons.mozilla.org/en-CA/firefox/addon/greasemonkey/ (Client side)
68 | * Mousehole: https://github.com/whymirror/mousehole
69 | * Jigsaw: https://www.w3.org/Jigsaw/Overview.html (I vaguely recall it could do some of this kind of thing - I could be wrong though)
70 | * Netlify: most recently has the same idea with their Edge (Handlers) https://www.netlify.com/products/edge/edge-handlers/
71 | * Soupault: Is the main inspiration for how stitcherd works. https://soupault.neocities.org/
72 |
73 | # License
74 |
75 | Apache 2.0
76 |
77 |
--------------------------------------------------------------------------------
/website/themes/juice/sass/juice.scss:
--------------------------------------------------------------------------------
1 | @import "_ultility.scss";
2 | @import "_text.scss";
3 | @import "_markdown.scss";
4 |
5 | body {
6 | padding: 0;
7 | margin: 0;
8 | box-sizing: border-box;
9 | background-color: var(--secondary-color);
10 | }
11 |
12 | a {
13 | text-decoration: none;
14 | }
15 |
16 | ul {
17 | margin-top: 0.5rem;
18 | }
19 |
20 | ul > li {
21 | padding: 0.3rem 0;
22 | }
23 |
24 | p > img {
25 | width: 100%;
26 | height: auto;
27 | }
28 |
29 | header {
30 | background-color: var(--primary-color);
31 | color: black;
32 | padding: 20px 50px;
33 | display: flex;
34 | align-items: center;
35 | justify-content: space-between;
36 | }
37 |
38 | .logo {
39 | font-family: "Alfa Slab One", serif;
40 | font-size: 32px;
41 | color: var(--primary-text-color);
42 | display: flex;
43 | align-items: center;
44 | margin: 0 40px;
45 |
46 | img {
47 | width: 60px;
48 | margin: 0 25px;
49 | }
50 | }
51 |
52 | .nav-item {
53 | margin: 0 10px;
54 | text-decoration: none;
55 | font-size: 18px;
56 | font-weight: bold;
57 |
58 | &:hover {
59 | color: #000;
60 | text-decoration: underline;
61 | }
62 | }
63 |
64 | .hero {
65 | display: flex;
66 | align-items: center;
67 | justify-content: space-evenly;
68 | height: 100vh;
69 | background-color: var(--primary-color);
70 | overflow-x: hidden;
71 | padding: 0 40px;
72 |
73 | .explore-more {
74 | position: absolute;
75 | bottom: 20px;
76 | left: 45%;
77 | cursor: pointer;
78 | }
79 | }
80 |
81 | main {
82 | display: flex;
83 | padding: 50px 100px;
84 |
85 | .toc {
86 | max-width: 260px;
87 | min-width: 240px;
88 | }
89 |
90 | .toc-item {
91 | padding: 10px 20px;
92 | color: #424242;
93 | }
94 |
95 | .toc-item a, .toc-item-child a {
96 | color: var(--secondary-text-color);
97 |
98 | &:hover {
99 | cursor: pointer;
100 | text-decoration: underline;
101 | }
102 | }
103 |
104 | .toc-item a.active, .toc-item-child a.active {
105 | color: var(--toc-highlight-text-color);
106 | }
107 |
108 | .toc-item-child {
109 | padding: 0 30px 5px;
110 | color: #424242;
111 | }
112 |
113 | }
114 |
115 | .toc-sticky {
116 | border-radius: 3px;
117 | border-top: 5px solid var(--primary-color);
118 | background-color: white;
119 | position: sticky;
120 | position: -webkit-sticky;
121 | position: -moz-sticky;
122 | position: -ms-sticky;
123 | position: -o-sticky;
124 | top: 10px;
125 | padding: 10px 0;
126 | }
127 |
128 | footer {
129 | padding: 50px;
130 | display: flex;
131 | flex-direction: column;
132 | justify-content: center;
133 | align-items: center;
134 | background-color: #202020;
135 | color: #fcfcfc;
136 |
137 | a {
138 | color: #fcfcfc;
139 | text-decoration: underline;
140 | }
141 | }
142 |
143 | @media screen and (max-width: 768px) {
144 | header {
145 | padding: 10px 30px;
146 | flex-direction: column;
147 | align-items: center;
148 | justify-content: center;
149 | }
150 |
151 | .logo {
152 | font-size: 28px;
153 | margin: 10px;
154 |
155 | img {
156 | width: 45px;
157 | margin: 0 10px 0 0;
158 | }
159 | }
160 |
161 | .nav-item {
162 | margin: 0 5px;
163 | font-size: 14px;
164 | }
165 |
166 | .hero {
167 | padding: 40px 30px;
168 | }
169 |
170 | main {
171 | padding: 30px;
172 | }
173 |
174 | .content {
175 | padding: 0;
176 | }
177 |
178 | .explore-more, .toc {
179 | display: none;
180 | }
181 |
182 | }
--------------------------------------------------------------------------------
/stitcher/server.go:
--------------------------------------------------------------------------------
1 | package stitcher
2 |
3 | import (
4 | "context"
5 | "fmt"
6 | "log"
7 | "net/http"
8 | "time"
9 |
10 | "github.com/gorilla/handlers"
11 | "github.com/gorilla/mux"
12 | )
13 |
14 | type Stitcherd struct {
15 |
16 | ListenAddress string
17 | WorkingDirectory string
18 |
19 | AdminHostName string
20 | AdminEnabled bool
21 |
22 | hosts map[string]*Host
23 | adminRouter *mux.Router
24 | }
25 |
26 | // Performs initialization
27 | func (stitcherd *Stitcherd) Init() *Stitcherd {
28 |
29 | stitcherd.hosts = make(map[string]*Host)
30 |
31 | if stitcherd.AdminEnabled {
32 | stitcherd.adminRouter = mux.NewRouter().Host(stitcherd.AdminHostName).Subrouter()
33 | stitcherd.adminRouter.HandleFunc("/hosts/load/{filename:.*}", stitcherd.AdminHandler())
34 | }
35 |
36 | return stitcherd
37 | }
38 |
39 | func (stitcherd *Stitcherd) ServeHTTP(w http.ResponseWriter, request *http.Request) {
40 |
41 | var host *Host = nil
42 |
43 | log.Printf("Request for Host: '%s'\n", request.Host)
44 |
45 | // Find a valid host matching request.host
46 | for _, h := range stitcherd.hosts {
47 | if h.Match(request.Host) {
48 | host = h
49 | break
50 | }
51 | }
52 |
53 | if host != nil {
54 | log.Printf("Processing...\n")
55 | host.Router.ServeHTTP(w, request)
56 | log.Printf("Done\n")
57 | } else if stitcherd.adminRouter != nil {
58 | stitcherd.adminRouter.ServeHTTP(w, request)
59 | } else {
60 | log.Printf("No handler, 404\n")
61 | w.WriteHeader(http.StatusNotFound)
62 | w.Write([]byte("404 - Not found\n"))
63 | }
64 | }
65 |
66 | // RunStictcherd serves up sites specified in hosts
67 | func (stitcherd *Stitcherd) Run(hostConfigFiles []string) {
68 | log.Printf("Start - admin hostname: '%s', working directory: '%s'\n",
69 | stitcherd.AdminHostName, stitcherd.WorkingDirectory)
70 |
71 | for _, file := range hostConfigFiles {
72 | host, err := NewHostFromFile(file)
73 | if err == nil {
74 | stitcherd.SetHost(host)
75 | }
76 | }
77 |
78 | cacheService := InitCache()
79 | defer cacheService.Shutdown(context.Background())
80 |
81 | srv := &http.Server{
82 | Addr: stitcherd.ListenAddress,
83 |
84 | // Good practice to set timeouts to avoid Slowloris attacks. TODO Timeout config
85 | WriteTimeout: time.Second * 15,
86 | ReadTimeout: time.Second * 15,
87 | IdleTimeout: time.Second * 60,
88 |
89 | // Stictcherd: Stictcherds.CombinedLoggingStictcherd(os.Stderr, Stictcherds.RecoveryStictcherd()(r)), // Pass our instance of gorilla/mux in.
90 | Handler: handlers.RecoveryHandler()(stitcherd),
91 | }
92 |
93 | // Run our Stictcherd in a goroutine so that it doesn't block.
94 | go func() {
95 | if err := srv.ListenAndServe(); err != nil {
96 | log.Println(err)
97 | }
98 | }()
99 |
100 | WaitForSignal(srv)
101 | }
102 |
103 | // Add or replace a host for the Stictcherd
104 | func (stitcherd *Stitcherd) SetHost(host *Host) {
105 | stitcherd.hosts[host.Hostname] = host
106 | }
107 |
108 | // Returns an AdminHandler func
109 | func (stitcherd *Stitcherd) AdminHandler() func(http.ResponseWriter, *http.Request) {
110 | return func(w http.ResponseWriter, r *http.Request) {
111 | vars := mux.Vars(r)
112 |
113 | filename := vars["filename"]
114 |
115 | log.Printf("AdminHandler: New Host File?: '%s'\n", filename)
116 |
117 | host, err := NewHostFromFile(filename)
118 |
119 | if err == nil {
120 | stitcherd.SetHost(host)
121 | w.WriteHeader(http.StatusOK)
122 | fmt.Fprintf(w, "Filename: %v OK\n", vars["filename"])
123 | log.Printf("AdminHandler: (re)Loaded %s\n", filename)
124 | } else {
125 | log.Printf("AdminHandler: Error Loading %s, %v\n", filename, err)
126 | w.WriteHeader(http.StatusInternalServerError)
127 | fmt.Fprintf(w, "filename: %v ERROR '%v'\n", vars["filename"], err)
128 | }
129 | }
130 | }
131 |
132 |
--------------------------------------------------------------------------------
/website/content/_index.md:
--------------------------------------------------------------------------------
1 | +++
2 | title = "Stitcherd"
3 | sort_by = "weight"
4 | +++
5 |
6 |
7 |
8 | Static sites are great. They're fast to serve, there's less to to go wrong and are hostable
9 | pretty much anywhere and any how you would like to. But sometimes, just sometimes there is
10 | some page or some part of every page that has dynamic or even personalized content on it.
11 | Stitcherd is for those times.
12 |
13 | It is a web server that reads some source content (typically a local static file, but could come from a remote source), fetches one or more pieces of remote “dynamic” content and injects them into the source document using a css selector to find the insertion point. These can be nested. The remote dynamic content can be remote html or output of a Go template that can also process remote html and/or remote json data.
14 |
15 | The resulting content is then served to the client. You can have multiple routes with different sets of content to be replaced (and indeed source document). In other words it does server side includes, but with css/dom manipulation and so doesn’t require special directives in the source documents.
16 |
17 | A couple of Use cases:
18 |
19 | * Fast e-commerce site with static product pages, but dynamic pricing/availability/promotions. Plus server side carts
20 | * Commenting system for static blogs. JS Free
21 | * Micro services/frontends
22 |
23 | Yes, it’s server that has to be hosted somewhere and you need to decide if that’s okay for your use case or not, but then so are most of the alternatives, except JS of course, but same-origin, et al leads it to be harder (imo) to use than this.
24 |
25 | ## Features
26 |
27 | ### Current
28 |
29 | * Multiple vhosts
30 | * CSS Selector page assembly
31 | * Static Content catch all (but... will allow proxy fallback soon)
32 | * Simple cache controls per endpoint/route (more types coming soon - ie etag, last modified etc.)
33 | * Go templates (with HTML and JSON Data retrieval) for endpoints
34 |
35 | ### Coming Soon
36 |
37 | * Bot detection (>800 known bots)
38 | * Both General and (Bot == true) rate limiting (Site wide and per route)
39 | * (Optional) Sessions
40 | * Proxy for fallback (eg / to some CMS) and for routes (eg /blog/ proxied to Wordpress)
41 | * Static content routes
42 | * Site Authentication (OAUTH/SAML end point config, basic auth? Builtin user/password (agencies?)). Authenticate routes?
43 | * HMAC auth support for backend ends
44 | * More control over endpoint request (ACTION/Verb, protocol, headers, cookies, form vars, etc )
45 |
46 | # Building
47 |
48 | Requires Go > 1.12
49 |
50 | Clone the repo and then a simple
51 |
52 | ```
53 | go build
54 | ```
55 |
56 | Docker image at some point
57 |
58 | # Examples
59 |
60 | There is a 'demo' folder that serves as an example/testbed
61 |
62 | ```
63 | ./stitcherd --host demo/site.hcl
64 | http://localhost:3000/
65 | ```
66 |
67 | The home page at https://stitcherd.vhodges.dev/ will also serve as an example (soon).
68 |
69 | * It pulls the index page content from the Github README.md (ie this file)
70 | * It pulls a list of recent posts to the Announcment mailing list from sourcehut
71 | * Source (and generated static site - via zola - are checked into source control under website)
72 |
73 | # Prior Art and Inspiration
74 |
75 | * Edge side includes (ESI) using Varnish https://varnish-cache.org/
76 | * shtml files and virtual paths in nginx
77 | * Greasemonkey: https://addons.mozilla.org/en-CA/firefox/addon/greasemonkey/ (Client side)
78 | * Mousehole: https://github.com/whymirror/mousehole
79 | * Jigsaw: https://www.w3.org/Jigsaw/Overview.html (I vaguely recall it could do some of this kind of thing - I could be wrong though)
80 | * Netlify: most recently has the same idea with their Edge (Handlers) https://www.netlify.com/products/edge/edge-handlers/
81 | * Soupault: Is the main inspiration for how stitcherd works. https://soupault.neocities.org/
82 |
83 | # License
84 |
85 | Apache 2.0
86 |
87 |
88 |
89 |
--------------------------------------------------------------------------------
/stitcher/fragment.go:
--------------------------------------------------------------------------------
1 | package stitcher
2 |
3 | import (
4 | "context"
5 | "encoding/json"
6 |
7 | "log"
8 | "strings"
9 | "time"
10 |
11 | "github.com/PuerkitoBio/goquery"
12 | "github.com/mailgun/groupcache/v2"
13 | "github.com/valyala/fasttemplate"
14 | )
15 |
16 | // Fragments are renderable pieces of markup with one at the top level
17 | // representing the page being sent to the browser.
18 | type Fragment struct {
19 |
20 | Fetcher FragmentFetcher
21 |
22 | Fragments []Fragment // Can be nested 0 or more
23 | DocumentTransforms []DocumentTransform
24 | TransformSelfTransforms []DocumentTransform
25 |
26 | CacheKey string `json:"cache,optional"`
27 | CacheTTL string `json:"ttl,optional"`
28 | }
29 |
30 | // Caching returns true if we are to use the endpoint
31 | func (fragment *Fragment) Cachable() bool {
32 | return fragment.CacheKey != ""
33 | }
34 |
35 | // InterpolatedCacheKey returns the interpolated endpoint key
36 | func (fragment *Fragment) InterpolatedCacheKey(contextData map[string]interface{}) string {
37 | t := fasttemplate.New(fragment.CacheKey, "{{", "}}")
38 | return t.ExecuteString(contextData)
39 |
40 | }
41 |
42 | func (fragment *Fragment) Render(site *Host, contextdata map[string]interface{}) string {
43 |
44 | var this_content string
45 | var this_doc *goquery.Document
46 | var err error
47 |
48 | this_content, err= fragment.Fetcher.Fetch(contextdata)
49 |
50 | if err != nil {
51 | return "" // TODO Handle error better.
52 | }
53 |
54 | this_doc, err = goquery.NewDocumentFromReader(strings.NewReader(this_content))
55 | if err != nil {
56 | return "" // TODO Handle error better.
57 | }
58 |
59 |
60 | for _, frag := range fragment.Fragments {
61 | var child_content string
62 | var child_doc *goquery.Document
63 |
64 | if frag.Cachable() {
65 | child_content, err = frag.FromCache(site, contextdata)
66 | if err != nil {
67 | continue; // Skip on error... TODO Log the error
68 | }
69 | } else {
70 | child_content = frag.Render(site, contextdata)
71 | }
72 |
73 | child_doc, err = goquery.NewDocumentFromReader(strings.NewReader(child_content))
74 | if err != nil {
75 | continue; // Skip on error, TODO log the error
76 | }
77 |
78 | for _, transformation := range frag.DocumentTransforms {
79 | transformation.Transform(this_doc, child_doc)
80 | }
81 | }
82 |
83 | for _, transformation := range fragment.TransformSelfTransforms {
84 | transformation.Transform(this_doc, nil) // Only makes sense for add_class
85 | }
86 |
87 |
88 | html, err2 := this_doc.Html()
89 |
90 | if err2 != nil {
91 | return "" // TODO Handle error better
92 | }
93 |
94 | return html
95 | }
96 |
97 | func (fragment *Fragment) GetData(contextdata map[string]interface{}) map[string]interface{} {
98 | var jsonData map[string]interface{}
99 |
100 | fetched_fragment, err := fragment.Fetcher.Fetch(contextdata)
101 |
102 | if err != nil {
103 | return nil // TODO Handle error better.
104 | }
105 |
106 | json.Unmarshal([]byte(fetched_fragment), &jsonData)
107 |
108 | return jsonData
109 | }
110 |
111 | func (fragment *Fragment) FromCache(site *Host, contextdata map[string]interface{}) (string, error) {
112 |
113 | var content string
114 |
115 | var contextvalue = FragmentRenderContext{Site: site, Fragment: fragment, ContextData: contextdata}
116 | ctx, cancel := context.WithTimeout(context.WithValue(context.Background(), requestContextKey("request"), contextvalue),
117 | time.Millisecond*2000) // TODO Make this configurable
118 |
119 | defer cancel()
120 |
121 | if err := site.Cache.Get(ctx, fragment.InterpolatedCacheKey(contextdata), groupcache.StringSink(&content)); err != nil {
122 | log.Printf("Error getting from cache: %v\n", err)
123 | return "", err
124 | }
125 |
126 | return content, nil
127 | }
128 |
129 | func FillFragmentCache(ctx context.Context, id string, dest groupcache.Sink) error {
130 | var err error
131 |
132 | v := ctx.Value(requestContextKey("request"))
133 |
134 | r, ok := v.(FragmentRenderContext)
135 |
136 | if ok {
137 |
138 | content := r.Fragment.Render(r.Site, r.ContextData)
139 |
140 | if err != nil {
141 | log.Printf("Error: %v - '%+v'\n", err, r.Fragment)
142 | return err
143 | }
144 |
145 | ttl, err := time.ParseDuration(r.Fragment.CacheTTL)
146 | if err != nil {
147 | log.Printf("Error parsing TTL duration: '%v' for key '%s' defaulting to a TTL of one minute\n", err, id)
148 | ttl = time.Minute * 1
149 | }
150 |
151 | if err := dest.SetString(content, time.Now().Add(ttl)); err != nil {
152 | log.Println("SetString", err)
153 | return err
154 | }
155 | }
156 |
157 | return nil
158 | }
159 |
--------------------------------------------------------------------------------
/stitcher/route.go:
--------------------------------------------------------------------------------
1 | package stitcher
2 |
3 | import (
4 | "fmt"
5 | "log"
6 | "os"
7 | "net/http"
8 | "strings"
9 | "time"
10 |
11 | "github.com/gorilla/mux"
12 | "github.com/x-way/crawlerdetect"
13 | "golang.org/x/time/rate"
14 | )
15 |
16 | // Route returns content for a given path
17 | type Route struct {
18 | Path string // Respond to requests at this path
19 |
20 | RouteDataFragment *Fragment
21 |
22 | RespondWith string
23 |
24 | // RespondWith "fragemented_page' renders this
25 | Page *FragmentedPage
26 |
27 | // ResponeWith 'static_files' servers this local directory to server
28 | StaticPath string
29 |
30 | // TODO
31 | // RedirectTo string // TODO interpolate
32 | // RedirectStatus // Eg 302 (Found) or 302 (Moved permanently)
33 |
34 | // ResponseString string // TODO Interpolate
35 | // ResponseCode string
36 |
37 | // ProxyHost string
38 | // ProxyString??? string
39 |
40 | // Rate limiter
41 | MaxRate float64
42 | AllowBurst int
43 | BotMaxRate float64
44 | BotAllowBurst int
45 |
46 | normalLimiter *rate.Limiter // Really only makes sense/applies to Route
47 | botLimiter *rate.Limiter
48 | }
49 |
50 | // Init creates runtime objects for the end point
51 | func (route *Route) Init(host *Host) {
52 |
53 | if route.MaxRate > 0 && route.AllowBurst > 0 {
54 | route.normalLimiter = rate.NewLimiter(rate.Limit(route.MaxRate),
55 | route.AllowBurst)
56 |
57 | log.Printf("Added rate limiter for '%s' Rate: %f Burst: %d\n",
58 | route.Path, rate.Limit(route.MaxRate), route.AllowBurst)
59 | }
60 |
61 | if route.BotMaxRate > 0 && route.BotAllowBurst > 0 {
62 | route.botLimiter = rate.NewLimiter(rate.Limit(route.BotMaxRate),
63 | route.BotAllowBurst)
64 |
65 | log.Printf("Added bot limiter for '%s' Rate: %f Burst: %d\n",
66 | route.Path, rate.Limit(route.BotMaxRate), route.BotAllowBurst)
67 | }
68 |
69 | // Add the handler for the route
70 | switch route.RespondWith {
71 | case "fragmented_page":
72 | host.Router.HandleFunc(route.Path, FragmentedPageHandler(host, *route))
73 | case "static_content":
74 | host.Router.PathPrefix(route.Path).Handler(http.StripPrefix(route.Path, http.FileServer(http.Dir(route.StaticPath))))
75 | case "redirect":
76 | case "proxy":
77 | }
78 |
79 | }
80 |
81 | // Throttling returns true if the current request is to be rate limited.
82 | func (route *Route) Throttling(r *http.Request) bool {
83 |
84 | var limiter = route.normalLimiter
85 |
86 | if route.botLimiter != nil && crawlerdetect.IsCrawler(r.UserAgent()) {
87 | log.Println("Crawler detected")
88 | limiter = route.botLimiter
89 | }
90 |
91 | if limiter != nil {
92 | return !limiter.Allow()
93 | }
94 |
95 | return false
96 | }
97 |
98 | func (route *Route) nextRequestID() string {
99 | return fmt.Sprintf("%d", time.Now().UnixNano())
100 | }
101 |
102 | // FragmentedPageHandler Renders the route.Page
103 | func (route *Route) FragmentedPageHandler(site *Host, w http.ResponseWriter, r *http.Request) {
104 | var err error
105 |
106 | start := time.Now()
107 |
108 | var fetchContext map[string]interface{} = make(map[string]interface{})
109 |
110 | if route.Throttling(r) {
111 | http.Error(w, http.StatusText(http.StatusTooManyRequests), http.StatusTooManyRequests)
112 | return
113 | }
114 |
115 | // TODO Better request tracing... (context.Context too?)
116 | fetchContext["_requestId"] = route.nextRequestID()
117 |
118 | // Any params passed in, make available to the request.
119 | for key, element := range mux.Vars(r) {
120 | fetchContext[key] = element
121 | }
122 |
123 | // Same for any env vars
124 | for _, e := range os.Environ() {
125 | pair := strings.SplitN(e, "=", 2)
126 | fetchContext[pair[0]] = pair[1]
127 | }
128 |
129 | // TODO these probably need to be escaped
130 | fetchContext["requestPath"] = r.URL.Path
131 | fetchContext["queryString"] = r.URL.RawQuery
132 |
133 | fetchContext["host"] = r.Host
134 |
135 | for key, element := range r.URL.Query() {
136 | if len(element) == 0 {
137 | fetchContext[key] = ""
138 | } else {
139 | fetchContext[key] = element[0]
140 | }
141 | }
142 |
143 | if route.RouteDataFragment != nil {
144 | log.Printf("RouteDataFragment was not nil\n")
145 |
146 | // Fetch a data blob Fragement to use to augment fetchContext
147 | routeData := route.RouteDataFragment.GetData(fetchContext)
148 |
149 | // Add the key,value pairs to fetchContext
150 | for k,v := range routeData {
151 | fetchContext[k] = v
152 | }
153 | }
154 |
155 |
156 | // TODO Add Headers? Cookies? to fetchContext
157 |
158 | content := route.Page.Render(site, fetchContext)
159 |
160 | if err != nil {
161 | log.Printf("Error from endpoint '%s': %v", route.Path, err)
162 | fmt.Fprintln(w, "")
163 | } else {
164 | fmt.Fprintln(w, content)
165 | }
166 |
167 | elapsed := time.Since(start)
168 | log.Println(fetchContext["_requestId"], r.Host, r.Method, r.URL.Path, r.Proto, elapsed)
169 | }
170 |
171 | // FragmentedPageHandler uses the Source to render content
172 | func FragmentedPageHandler(site *Host, route Route) func(http.ResponseWriter, *http.Request) {
173 | return func(w http.ResponseWriter, r *http.Request) {
174 | route.FragmentedPageHandler(site, w, r)
175 | }
176 | }
177 |
--------------------------------------------------------------------------------
/demo/site.json:
--------------------------------------------------------------------------------
1 | {
2 | "Hostname": ".*",
3 | "Routes": [
4 | {
5 | "Path": "/users",
6 | "RespondWith": "fragmented_page",
7 |
8 | "MaxRate": 10.0,
9 | "Burst": 50,
10 | "BotMaxRate": 2.0,
11 | "BotBurst": 5,
12 |
13 | "RouteDataFragment": {
14 | "CacheKey": "/users-data-fragement/{{host}}",
15 | "CacheTTL": "30s",
16 |
17 | "Fetcher": {
18 | "Type": "file",
19 | "Source": "demo/data-fragments/{{host}}.json"
20 | },
21 | "Fragments": []
22 | },
23 | "Page": {
24 | "Fragment": {
25 | "CacheKey": "/users",
26 | "CacheTTL": "30s",
27 |
28 | "Fetcher": {
29 | "Type": "file",
30 | "Source": "demo/html/index.html"
31 | },
32 | "Fragments": [
33 | {
34 | "Fetcher": {
35 | "Type": "uri",
36 | "Source": "https://jsonplaceholder.typicode.com/users",
37 | "IsJson": true,
38 | "Template": "demo/template/users.tmpl"
39 | },
40 | "DocumentTransforms": [
41 | {
42 | "Type": "replace",
43 | "ParentSelector": "#replaceme"
44 | }
45 | ]
46 | }
47 | ]
48 | }
49 | }
50 | },
51 | {
52 | "Path": "/users/{userid}",
53 | "RespondWith": "fragmented_page",
54 |
55 | "Page": {
56 | "Fragment": {
57 | "CacheKey": "/users/{{userid}}",
58 | "CacheTTL": "10s",
59 |
60 | "Fetcher": {
61 | "Type": "file",
62 | "Source": "demo/html/index.html"
63 | },
64 | "Fragments": [
65 | {
66 | "CacheKey": "JSON:/users/{{userid}}",
67 | "CacheTTL": "5m",
68 | "Fetcher": {
69 | "Type": "uri",
70 | "Source": "https://jsonplaceholder.typicode.com/users/{{userid}}",
71 | "IsJson": true,
72 | "Template": "demo/template/user.tmpl"
73 | },
74 | "DocumentTransforms": [
75 | {
76 | "Type": "replace",
77 | "ParentSelector": "#replaceme"
78 | }
79 | ]
80 | },
81 | {
82 | "CacheKey": "JSON:/todos/{{userid}}",
83 | "CacheTTL": "1m",
84 | "Fetcher": {
85 | "Type": "uri",
86 | "Source": "https://jsonplaceholder.typicode.com/todos?userId={{userid}}",
87 | "IsJson": true,
88 | "Template": "demo/template/todos.tmpl"
89 | },
90 | "DocumentTransforms": [
91 | {
92 | "Type": "replace",
93 | "ParentSelector": "#todo_list"
94 | }
95 | ]
96 | }
97 | ]
98 | }
99 | }
100 | },
101 | {
102 | "Path": "/{folderPath:.*\\/$}",
103 | "RespondWith": "fragmented_page",
104 |
105 | "Page": {
106 | "Fragment": {
107 | "Fetcher":{
108 | "Type": "file",
109 | "Source": "demo/html/{{folderPath}}index.html"
110 | },
111 | "Fragments":[
112 | {
113 | "Fetcher":{
114 | "Source": "This is the other replacement string (one)
"
115 | },
116 | "DocumentTransforms": [
117 | {
118 | "Type": "replace",
119 | "ParentSelector": "#replaceme"
120 | }
121 | ]
122 | }
123 | ]
124 | }
125 | }
126 | },
127 | {
128 | "Path": "/{rest:.*html$}",
129 | "RespondWith": "fragmented_page",
130 |
131 | "Page": {
132 | "Fragment": {
133 | "Fetcher":{
134 | "Type": "file",
135 | "Source": "demo/html/{{rest}}"
136 | },
137 | "Fragments":[
138 | {
139 | "Fetcher":{
140 | "Source": "This is another replacement string (two)
"
141 | },
142 | "DocumentTransforms": [
143 | {
144 | "Type": "replace",
145 | "ParentSelector": "#replaceme"
146 | }
147 | ]
148 | }
149 | ]
150 | }
151 | }
152 | },
153 | {
154 | "Path": "/",
155 | "RespondWith": "static_content",
156 | "StaticPath": "demo/html"
157 | }
158 | ]
159 | }
160 |
--------------------------------------------------------------------------------
/website/public/normalize.css:
--------------------------------------------------------------------------------
1 | /*! normalize.css v8.0.1 | MIT License | github.com/necolas/normalize.css */
2 |
3 | /* Document
4 | ========================================================================== */
5 |
6 | /**
7 | * 1. Correct the line height in all browsers.
8 | * 2. Prevent adjustments of font size after orientation changes in iOS.
9 | */
10 |
11 | html {
12 | line-height: 1.15; /* 1 */
13 | -webkit-text-size-adjust: 100%; /* 2 */
14 | }
15 |
16 | /* Sections
17 | ========================================================================== */
18 |
19 | /**
20 | * Remove the margin in all browsers.
21 | */
22 |
23 | body {
24 | margin: 0;
25 | }
26 |
27 | /**
28 | * Render the `main` element consistently in IE.
29 | */
30 |
31 | main {
32 | display: block;
33 | }
34 |
35 | /**
36 | * Correct the font size and margin on `h1` elements within `section` and
37 | * `article` contexts in Chrome, Firefox, and Safari.
38 | */
39 |
40 | h1 {
41 | font-size: 2em;
42 | margin: 0.67em 0;
43 | }
44 |
45 | /* Grouping content
46 | ========================================================================== */
47 |
48 | /**
49 | * 1. Add the correct box sizing in Firefox.
50 | * 2. Show the overflow in Edge and IE.
51 | */
52 |
53 | hr {
54 | box-sizing: content-box; /* 1 */
55 | height: 0; /* 1 */
56 | overflow: visible; /* 2 */
57 | }
58 |
59 | /**
60 | * 1. Correct the inheritance and scaling of font size in all browsers.
61 | * 2. Correct the odd `em` font sizing in all browsers.
62 | */
63 |
64 | pre {
65 | font-family: monospace, monospace; /* 1 */
66 | font-size: 1em; /* 2 */
67 | }
68 |
69 | /* Text-level semantics
70 | ========================================================================== */
71 |
72 | /**
73 | * Remove the gray background on active links in IE 10.
74 | */
75 |
76 | a {
77 | background-color: transparent;
78 | }
79 |
80 | /**
81 | * 1. Remove the bottom border in Chrome 57-
82 | * 2. Add the correct text decoration in Chrome, Edge, IE, Opera, and Safari.
83 | */
84 |
85 | abbr[title] {
86 | border-bottom: none; /* 1 */
87 | text-decoration: underline; /* 2 */
88 | text-decoration: underline dotted; /* 2 */
89 | }
90 |
91 | /**
92 | * Add the correct font weight in Chrome, Edge, and Safari.
93 | */
94 |
95 | b,
96 | strong {
97 | font-weight: bolder;
98 | }
99 |
100 | /**
101 | * 1. Correct the inheritance and scaling of font size in all browsers.
102 | * 2. Correct the odd `em` font sizing in all browsers.
103 | */
104 |
105 | code,
106 | kbd,
107 | samp {
108 | font-family: monospace, monospace; /* 1 */
109 | font-size: 1em; /* 2 */
110 | }
111 |
112 | /**
113 | * Add the correct font size in all browsers.
114 | */
115 |
116 | small {
117 | font-size: 80%;
118 | }
119 |
120 | /**
121 | * Prevent `sub` and `sup` elements from affecting the line height in
122 | * all browsers.
123 | */
124 |
125 | sub,
126 | sup {
127 | font-size: 75%;
128 | line-height: 0;
129 | position: relative;
130 | vertical-align: baseline;
131 | }
132 |
133 | sub {
134 | bottom: -0.25em;
135 | }
136 |
137 | sup {
138 | top: -0.5em;
139 | }
140 |
141 | /* Embedded content
142 | ========================================================================== */
143 |
144 | /**
145 | * Remove the border on images inside links in IE 10.
146 | */
147 |
148 | img {
149 | border-style: none;
150 | }
151 |
152 | /* Forms
153 | ========================================================================== */
154 |
155 | /**
156 | * 1. Change the font styles in all browsers.
157 | * 2. Remove the margin in Firefox and Safari.
158 | */
159 |
160 | button,
161 | input,
162 | optgroup,
163 | select,
164 | textarea {
165 | font-family: inherit; /* 1 */
166 | font-size: 100%; /* 1 */
167 | line-height: 1.15; /* 1 */
168 | margin: 0; /* 2 */
169 | }
170 |
171 | /**
172 | * Show the overflow in IE.
173 | * 1. Show the overflow in Edge.
174 | */
175 |
176 | button,
177 | input { /* 1 */
178 | overflow: visible;
179 | }
180 |
181 | /**
182 | * Remove the inheritance of text transform in Edge, Firefox, and IE.
183 | * 1. Remove the inheritance of text transform in Firefox.
184 | */
185 |
186 | button,
187 | select { /* 1 */
188 | text-transform: none;
189 | }
190 |
191 | /**
192 | * Correct the inability to style clickable types in iOS and Safari.
193 | */
194 |
195 | button,
196 | [type="button"],
197 | [type="reset"],
198 | [type="submit"] {
199 | -webkit-appearance: button;
200 | }
201 |
202 | /**
203 | * Remove the inner border and padding in Firefox.
204 | */
205 |
206 | button::-moz-focus-inner,
207 | [type="button"]::-moz-focus-inner,
208 | [type="reset"]::-moz-focus-inner,
209 | [type="submit"]::-moz-focus-inner {
210 | border-style: none;
211 | padding: 0;
212 | }
213 |
214 | /**
215 | * Restore the focus styles unset by the previous rule.
216 | */
217 |
218 | button:-moz-focusring,
219 | [type="button"]:-moz-focusring,
220 | [type="reset"]:-moz-focusring,
221 | [type="submit"]:-moz-focusring {
222 | outline: 1px dotted ButtonText;
223 | }
224 |
225 | /**
226 | * Correct the padding in Firefox.
227 | */
228 |
229 | fieldset {
230 | padding: 0.35em 0.75em 0.625em;
231 | }
232 |
233 | /**
234 | * 1. Correct the text wrapping in Edge and IE.
235 | * 2. Correct the color inheritance from `fieldset` elements in IE.
236 | * 3. Remove the padding so developers are not caught out when they zero out
237 | * `fieldset` elements in all browsers.
238 | */
239 |
240 | legend {
241 | box-sizing: border-box; /* 1 */
242 | color: inherit; /* 2 */
243 | display: table; /* 1 */
244 | max-width: 100%; /* 1 */
245 | padding: 0; /* 3 */
246 | white-space: normal; /* 1 */
247 | }
248 |
249 | /**
250 | * Add the correct vertical alignment in Chrome, Firefox, and Opera.
251 | */
252 |
253 | progress {
254 | vertical-align: baseline;
255 | }
256 |
257 | /**
258 | * Remove the default vertical scrollbar in IE 10+.
259 | */
260 |
261 | textarea {
262 | overflow: auto;
263 | }
264 |
265 | /**
266 | * 1. Add the correct box sizing in IE 10.
267 | * 2. Remove the padding in IE 10.
268 | */
269 |
270 | [type="checkbox"],
271 | [type="radio"] {
272 | box-sizing: border-box; /* 1 */
273 | padding: 0; /* 2 */
274 | }
275 |
276 | /**
277 | * Correct the cursor style of increment and decrement buttons in Chrome.
278 | */
279 |
280 | [type="number"]::-webkit-inner-spin-button,
281 | [type="number"]::-webkit-outer-spin-button {
282 | height: auto;
283 | }
284 |
285 | /**
286 | * 1. Correct the odd appearance in Chrome and Safari.
287 | * 2. Correct the outline style in Safari.
288 | */
289 |
290 | [type="search"] {
291 | -webkit-appearance: textfield; /* 1 */
292 | outline-offset: -2px; /* 2 */
293 | }
294 |
295 | /**
296 | * Remove the inner padding in Chrome and Safari on macOS.
297 | */
298 |
299 | [type="search"]::-webkit-search-decoration {
300 | -webkit-appearance: none;
301 | }
302 |
303 | /**
304 | * 1. Correct the inability to style clickable types in iOS and Safari.
305 | * 2. Change font properties to `inherit` in Safari.
306 | */
307 |
308 | ::-webkit-file-upload-button {
309 | -webkit-appearance: button; /* 1 */
310 | font: inherit; /* 2 */
311 | }
312 |
313 | /* Interactive
314 | ========================================================================== */
315 |
316 | /*
317 | * Add the correct display in Edge, IE 10+, and Firefox.
318 | */
319 |
320 | details {
321 | display: block;
322 | }
323 |
324 | /*
325 | * Add the correct display in all browsers.
326 | */
327 |
328 | summary {
329 | display: list-item;
330 | }
331 |
332 | /* Misc
333 | ========================================================================== */
334 |
335 | /**
336 | * Add the correct display in IE 10+.
337 | */
338 |
339 | template {
340 | display: none;
341 | }
342 |
343 | /**
344 | * Add the correct display in IE 10.
345 | */
346 |
347 | [hidden] {
348 | display: none;
349 | }
350 |
--------------------------------------------------------------------------------
/website/themes/juice/static/normalize.css:
--------------------------------------------------------------------------------
1 | /*! normalize.css v8.0.1 | MIT License | github.com/necolas/normalize.css */
2 |
3 | /* Document
4 | ========================================================================== */
5 |
6 | /**
7 | * 1. Correct the line height in all browsers.
8 | * 2. Prevent adjustments of font size after orientation changes in iOS.
9 | */
10 |
11 | html {
12 | line-height: 1.15; /* 1 */
13 | -webkit-text-size-adjust: 100%; /* 2 */
14 | }
15 |
16 | /* Sections
17 | ========================================================================== */
18 |
19 | /**
20 | * Remove the margin in all browsers.
21 | */
22 |
23 | body {
24 | margin: 0;
25 | }
26 |
27 | /**
28 | * Render the `main` element consistently in IE.
29 | */
30 |
31 | main {
32 | display: block;
33 | }
34 |
35 | /**
36 | * Correct the font size and margin on `h1` elements within `section` and
37 | * `article` contexts in Chrome, Firefox, and Safari.
38 | */
39 |
40 | h1 {
41 | font-size: 2em;
42 | margin: 0.67em 0;
43 | }
44 |
45 | /* Grouping content
46 | ========================================================================== */
47 |
48 | /**
49 | * 1. Add the correct box sizing in Firefox.
50 | * 2. Show the overflow in Edge and IE.
51 | */
52 |
53 | hr {
54 | box-sizing: content-box; /* 1 */
55 | height: 0; /* 1 */
56 | overflow: visible; /* 2 */
57 | }
58 |
59 | /**
60 | * 1. Correct the inheritance and scaling of font size in all browsers.
61 | * 2. Correct the odd `em` font sizing in all browsers.
62 | */
63 |
64 | pre {
65 | font-family: monospace, monospace; /* 1 */
66 | font-size: 1em; /* 2 */
67 | }
68 |
69 | /* Text-level semantics
70 | ========================================================================== */
71 |
72 | /**
73 | * Remove the gray background on active links in IE 10.
74 | */
75 |
76 | a {
77 | background-color: transparent;
78 | }
79 |
80 | /**
81 | * 1. Remove the bottom border in Chrome 57-
82 | * 2. Add the correct text decoration in Chrome, Edge, IE, Opera, and Safari.
83 | */
84 |
85 | abbr[title] {
86 | border-bottom: none; /* 1 */
87 | text-decoration: underline; /* 2 */
88 | text-decoration: underline dotted; /* 2 */
89 | }
90 |
91 | /**
92 | * Add the correct font weight in Chrome, Edge, and Safari.
93 | */
94 |
95 | b,
96 | strong {
97 | font-weight: bolder;
98 | }
99 |
100 | /**
101 | * 1. Correct the inheritance and scaling of font size in all browsers.
102 | * 2. Correct the odd `em` font sizing in all browsers.
103 | */
104 |
105 | code,
106 | kbd,
107 | samp {
108 | font-family: monospace, monospace; /* 1 */
109 | font-size: 1em; /* 2 */
110 | }
111 |
112 | /**
113 | * Add the correct font size in all browsers.
114 | */
115 |
116 | small {
117 | font-size: 80%;
118 | }
119 |
120 | /**
121 | * Prevent `sub` and `sup` elements from affecting the line height in
122 | * all browsers.
123 | */
124 |
125 | sub,
126 | sup {
127 | font-size: 75%;
128 | line-height: 0;
129 | position: relative;
130 | vertical-align: baseline;
131 | }
132 |
133 | sub {
134 | bottom: -0.25em;
135 | }
136 |
137 | sup {
138 | top: -0.5em;
139 | }
140 |
141 | /* Embedded content
142 | ========================================================================== */
143 |
144 | /**
145 | * Remove the border on images inside links in IE 10.
146 | */
147 |
148 | img {
149 | border-style: none;
150 | }
151 |
152 | /* Forms
153 | ========================================================================== */
154 |
155 | /**
156 | * 1. Change the font styles in all browsers.
157 | * 2. Remove the margin in Firefox and Safari.
158 | */
159 |
160 | button,
161 | input,
162 | optgroup,
163 | select,
164 | textarea {
165 | font-family: inherit; /* 1 */
166 | font-size: 100%; /* 1 */
167 | line-height: 1.15; /* 1 */
168 | margin: 0; /* 2 */
169 | }
170 |
171 | /**
172 | * Show the overflow in IE.
173 | * 1. Show the overflow in Edge.
174 | */
175 |
176 | button,
177 | input { /* 1 */
178 | overflow: visible;
179 | }
180 |
181 | /**
182 | * Remove the inheritance of text transform in Edge, Firefox, and IE.
183 | * 1. Remove the inheritance of text transform in Firefox.
184 | */
185 |
186 | button,
187 | select { /* 1 */
188 | text-transform: none;
189 | }
190 |
191 | /**
192 | * Correct the inability to style clickable types in iOS and Safari.
193 | */
194 |
195 | button,
196 | [type="button"],
197 | [type="reset"],
198 | [type="submit"] {
199 | -webkit-appearance: button;
200 | }
201 |
202 | /**
203 | * Remove the inner border and padding in Firefox.
204 | */
205 |
206 | button::-moz-focus-inner,
207 | [type="button"]::-moz-focus-inner,
208 | [type="reset"]::-moz-focus-inner,
209 | [type="submit"]::-moz-focus-inner {
210 | border-style: none;
211 | padding: 0;
212 | }
213 |
214 | /**
215 | * Restore the focus styles unset by the previous rule.
216 | */
217 |
218 | button:-moz-focusring,
219 | [type="button"]:-moz-focusring,
220 | [type="reset"]:-moz-focusring,
221 | [type="submit"]:-moz-focusring {
222 | outline: 1px dotted ButtonText;
223 | }
224 |
225 | /**
226 | * Correct the padding in Firefox.
227 | */
228 |
229 | fieldset {
230 | padding: 0.35em 0.75em 0.625em;
231 | }
232 |
233 | /**
234 | * 1. Correct the text wrapping in Edge and IE.
235 | * 2. Correct the color inheritance from `fieldset` elements in IE.
236 | * 3. Remove the padding so developers are not caught out when they zero out
237 | * `fieldset` elements in all browsers.
238 | */
239 |
240 | legend {
241 | box-sizing: border-box; /* 1 */
242 | color: inherit; /* 2 */
243 | display: table; /* 1 */
244 | max-width: 100%; /* 1 */
245 | padding: 0; /* 3 */
246 | white-space: normal; /* 1 */
247 | }
248 |
249 | /**
250 | * Add the correct vertical alignment in Chrome, Firefox, and Opera.
251 | */
252 |
253 | progress {
254 | vertical-align: baseline;
255 | }
256 |
257 | /**
258 | * Remove the default vertical scrollbar in IE 10+.
259 | */
260 |
261 | textarea {
262 | overflow: auto;
263 | }
264 |
265 | /**
266 | * 1. Add the correct box sizing in IE 10.
267 | * 2. Remove the padding in IE 10.
268 | */
269 |
270 | [type="checkbox"],
271 | [type="radio"] {
272 | box-sizing: border-box; /* 1 */
273 | padding: 0; /* 2 */
274 | }
275 |
276 | /**
277 | * Correct the cursor style of increment and decrement buttons in Chrome.
278 | */
279 |
280 | [type="number"]::-webkit-inner-spin-button,
281 | [type="number"]::-webkit-outer-spin-button {
282 | height: auto;
283 | }
284 |
285 | /**
286 | * 1. Correct the odd appearance in Chrome and Safari.
287 | * 2. Correct the outline style in Safari.
288 | */
289 |
290 | [type="search"] {
291 | -webkit-appearance: textfield; /* 1 */
292 | outline-offset: -2px; /* 2 */
293 | }
294 |
295 | /**
296 | * Remove the inner padding in Chrome and Safari on macOS.
297 | */
298 |
299 | [type="search"]::-webkit-search-decoration {
300 | -webkit-appearance: none;
301 | }
302 |
303 | /**
304 | * 1. Correct the inability to style clickable types in iOS and Safari.
305 | * 2. Change font properties to `inherit` in Safari.
306 | */
307 |
308 | ::-webkit-file-upload-button {
309 | -webkit-appearance: button; /* 1 */
310 | font: inherit; /* 2 */
311 | }
312 |
313 | /* Interactive
314 | ========================================================================== */
315 |
316 | /*
317 | * Add the correct display in Edge, IE 10+, and Firefox.
318 | */
319 |
320 | details {
321 | display: block;
322 | }
323 |
324 | /*
325 | * Add the correct display in all browsers.
326 | */
327 |
328 | summary {
329 | display: list-item;
330 | }
331 |
332 | /* Misc
333 | ========================================================================== */
334 |
335 | /**
336 | * Add the correct display in IE 10+.
337 | */
338 |
339 | template {
340 | display: none;
341 | }
342 |
343 | /**
344 | * Add the correct display in IE 10.
345 | */
346 |
347 | [hidden] {
348 | display: none;
349 | }
350 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "[]"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright [yyyy] [name of copyright owner]
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
--------------------------------------------------------------------------------
/website/themes/juice/content/juice.svg:
--------------------------------------------------------------------------------
1 | 
4 |
5 | **Juice** is an intuitive, elegant, and responsive Zola theme for product sites.
6 |
7 | - Build for product sites
8 | - Simple and intuitive structure
9 | - Clean and elegant design
10 | - Responsive and mobile device compatible
11 | - Customize and extend friendly
12 |
13 | https://juice.huhu.io
14 |
15 | # Installation
16 |
17 | First download this theme to your `themes` directory:
18 |
19 | ```bash
20 | $ cd themes
21 | $ git clone https://github.com/huhu/juice.git
22 | ```
23 |
24 | or add as a submodule
25 | ```bash
26 | $ git submodule add https://github.com/huhu/juice themes/juice
27 | ```
28 |
29 | and then enable it in your `config.toml`:
30 |
31 | ```toml
32 | theme = "juice"
33 | ```
34 |
35 | # Structure
36 |
37 | ### Hero
38 |
39 | **Juice** is designed for product websites, hence we let **hero** part fills whole of screen.
40 | You can customize your **hero** by using `hero` block in the `index.html`.
41 |
42 | ```html
43 | {% block hero %}
44 |