Code Monkey home page Code Monkey logo

eleventy-wikibonsai's Introduction

eleventy-wikibonsai

A WikiBonsai Project

An 11ty base blog with wikibonsai support.

You can see the live demo here.

πŸ’ Display your πŸŽ‹ WikiBonsai digital garden for others.

Getting Started

1. Clone this Repository

git clone https://github.com/wikibonsai/eleventy-wikibonsai.git my-blog-name

2. Navigate to the directory

cd my-blog-name

Specifically have a look at .eleventy.js to see if you want to configure any Eleventy options differently.

3. Install dependencies

npm install

4. Run

npx @11ty/eleventy

Or build and host locally for local development

npx @11ty/eleventy --serve

Or build automatically when a template changes:

npx @11ty/eleventy --watch

Or in debug mode:

DEBUG=* npx @11ty/eleventy

πŸͺ΄ Project Structure

Inside of your Astro-Wikibonsai project, you'll see the following folders and files:

β”œβ”€β”€ _data/
β”œβ”€β”€ _includes/
β”‚Β Β  └── layouts/
β”œβ”€β”€ content/
β”œβ”€β”€ css/
β”œβ”€β”€ img/
β”œβ”€β”€ wikibonsai/
β”œβ”€β”€ .eleventy.js
β”œβ”€β”€ .eleventyignore
β”œβ”€β”€ README.md
└── package.json
  • about/index.md shows how to add a content page.
  • posts/ has the blog posts but really they can live in any directory. They need only the post tag to be added to this collection.
  • Use the eleventyNavigation key in your front matter to add a template to the top level site navigation. For example, this is in use on index.njk and about/index.md.
  • Content can be any template format (blog posts needn’t be markdown, for example). Configure your supported templates in .eleventy.js -> templateFormats.
  • The css and img directories in the input directory will be copied to the output folder (via addPassthroughCopy() in the .eleventy.js file).
  • The blog post feed template is in feed/feed.njk. This is also a good example of using a global data files in that it uses _data/metadata.json.
  • This example uses three layouts:
    • _includes/layouts/base.njk: the top level HTML structure
    • _includes/layouts/home.njk: the home page template (wrapped into base.njk)
    • _includes/layouts/post.njk: the blog post template (wrapped into base.njk)
  • _includes/postlist.njk is a Nunjucks include and is a reusable component used to display a list of all the posts. index.njk has an example of how to use it.

🧚 Commands

All commands are run from the root of the project, from a terminal:

Command Action
npm install Installs dependencies
npm run build Build your production site to ./dist/
npm run bench Run benchmarks
npm run watch Preview your build locally, watch for changes
npm run serve Starts local dev server at localhost:4321
npm run start Preview your build locally, before deploying
npm run debug Run in debug mode

πŸ‘€ Want to learn more?

Check out the eleventy documentation or WikiBonsai documentation.

eleventy-wikibonsai's People

Contributors

manunamz avatar

Stargazers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

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

  • Vue.js photo Vue.js

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

  • Typescript photo Typescript

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

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

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

Recommend Topics

  • javascript

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

  • web

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

  • server

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

  • Machine learning

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

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

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

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.