chore: add documentation, remove comments and old files
parent
ee37fc6f06
commit
5ae9f63745
79
README.md
79
README.md
|
|
@ -1,80 +1,17 @@
|
||||||
# eleventy-base-blog
|
# IT's on us Blog
|
||||||
|
|
||||||
A starter repository showing how to build a (multi-language friendly) blog with the [Eleventy](https://github.com/11ty/eleventy) static site generator.
|
This web site is generated using [Eleventy](https://www.11ty.dev/).
|
||||||
|
|
||||||
[](https://travis-ci.org/11ty/eleventy-base-blog)
|
|
||||||
|
|
||||||
## Demos
|
## Installation
|
||||||
|
|
||||||
- [Netlify](https://eleventy-base-blog.netlify.com/)
|
Use NPM to install dependencies.
|
||||||
- [GitHub Pages](https://11ty.github.io/eleventy-base-blog/)
|
|
||||||
- [Remix on Glitch](https://glitch.com/~11ty-eleventy-base-blog)
|
|
||||||
|
|
||||||
## Deploy this to your own site
|
```bash
|
||||||
|
|
||||||
Deploy this Eleventy site in just a few clicks on these services:
|
|
||||||
|
|
||||||
- [Get your own Eleventy web site on Netlify](https://app.netlify.com/start/deploy?repository=https://github.com/11ty/eleventy-base-blog)
|
|
||||||
- [Get your own Eleventy web site on Vercel](https://vercel.com/import/project?template=11ty%2Feleventy-base-blog)
|
|
||||||
|
|
||||||
Or, read more about [Deploying an Eleventy project](https://www.11ty.dev/docs/deployment/).
|
|
||||||
|
|
||||||
## Getting Started
|
|
||||||
|
|
||||||
### 1. Clone this Repository
|
|
||||||
|
|
||||||
```
|
|
||||||
git clone https://github.com/11ty/eleventy-base-blog.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
|
npm install
|
||||||
```
|
```
|
||||||
|
|
||||||
### 4. Edit \_data/metadata.json
|
## Usage
|
||||||
|
Run ```npm run dev``` to start up a web server. Then open http://localhost:8080/ in your web browser to see the web site.
|
||||||
### 5. Run Eleventy
|
|
||||||
|
|
||||||
```
|
|
||||||
npx @11ty/eleventy
|
|
||||||
```
|
|
||||||
|
|
||||||
Or build and host locally for local development
|
|
||||||
|
|
||||||
```
|
|
||||||
npx @11ty/eleventy --serve
|
|
||||||
```
|
|
||||||
|
|
||||||
Or in debug mode:
|
|
||||||
|
|
||||||
```
|
|
||||||
DEBUG=Eleventy* npx @11ty/eleventy
|
|
||||||
```
|
|
||||||
|
|
||||||
### Implementation Notes
|
|
||||||
|
|
||||||
- `en` is the folder for content (written using the primary language for project, here we’re using English)
|
|
||||||
- `en/about/index.md` is an example of an English content page.
|
|
||||||
- `en/blog/` has the English blog posts but really they can live in any directory. They need only the `post` tag to be included in the blog posts [collection](https://www.11ty.dev/docs/collections/).
|
|
||||||
- To localize a blog post you will need to add a top level folder for that language (`es` for Spanish, `ja` for Japanese, `en-us` for American English) and match the rest of the file path to the primary language folder. For example `en/blog/my-post.md` could have `ja/blog/my-post.md` or `es/blog/my-post.md`. Read more about [best practices for organizing files for internationalization (i18n) in Eleventy projects](https://www.11ty.dev/docs/i18n/).
|
|
||||||
- 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`.
|
|
||||||
- This makes use of the [Eleventy Navigation plugin](https://www.11ty.dev/docs/plugins/navigation/)
|
|
||||||
- Content can be any template format (blog posts needn’t be markdown, for example). Configure your supported templates in `.eleventy.js` -> `templateFormats`.
|
|
||||||
- The `public` folder in your input directory will be copied to the output folder (via `addPassthroughCopy()` in the `.eleventy.js` file). This means `./public/css/*` will live at `./_site/css/*` after your build completes. [When using `--serve` this behavior is emulated](/docs/copy/#passthrough-during-serve) (the files will not show up in `_site`).
|
|
||||||
- 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 project uses three layouts:
|
|
||||||
- `_layouts/base.njk`: the top level HTML structure
|
|
||||||
- `_layouts/home.njk`: the home page template (wrapped into `base.njk`)
|
|
||||||
- `_layouts/post.njk`: the blog post template (wrapped into `base.njk`)
|
|
||||||
- `_components/postslist.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.
|
|
||||||
|
|
||||||
|
Run ```npm run prod``` to build a production version.
|
||||||
|
|
|
||||||
|
|
@ -153,178 +153,3 @@ module.exports = function(eleventyConfig) {
|
||||||
},
|
},
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
|
||||||
// const fs = require("fs");
|
|
||||||
// const path = require("path");
|
|
||||||
// const { DateTime } = require("luxon");
|
|
||||||
// const rosetta = require("rosetta");
|
|
||||||
// const markdownItAnchor = require("markdown-it-anchor");
|
|
||||||
// const pluginRss = require("@11ty/eleventy-plugin-rss");
|
|
||||||
// const pluginSyntaxHighlight = require("@11ty/eleventy-plugin-syntaxhighlight");
|
|
||||||
// const pluginNavigation = require("@11ty/eleventy-navigation");
|
|
||||||
// const { EleventyI18nPlugin, EleventyHtmlBasePlugin } = require("@11ty/eleventy");
|
|
||||||
// const languageStrings = require("./i18n.js");
|
|
||||||
// let markdownIt = require("markdown-it");
|
|
||||||
// let options = {
|
|
||||||
// // whatever options you have set for the library here
|
|
||||||
// };
|
|
||||||
// let mdfigcaption = require('markdown-it-image-figures');
|
|
||||||
// let figoptions = {
|
|
||||||
// figcaption: true
|
|
||||||
// };
|
|
||||||
// const mdLib = markdownIt(options).use(mdfigcaption, figoptions);
|
|
||||||
//
|
|
||||||
// const manifestPath = path.resolve(__dirname, "_site", "assets", "manifest.json");
|
|
||||||
// const manifest = JSON.parse(
|
|
||||||
// fs.readFileSync(manifestPath, { encoding: "utf8" })
|
|
||||||
// );
|
|
||||||
//
|
|
||||||
// module.exports = function(eleventyConfig) {
|
|
||||||
// eleventyConfig.ignores.add("README.md");
|
|
||||||
//
|
|
||||||
// eleventyConfig.setLibrary("md", mdLib);
|
|
||||||
//
|
|
||||||
// // Adds a universal shortcode to return the URL to a webpack asset. In Nunjack templates:
|
|
||||||
// // {% webpackAsset 'main.js' %} or {% webpackAsset 'main.css' %}
|
|
||||||
// eleventyConfig.addShortcode("webpackAsset", function(name) {
|
|
||||||
// if (!manifest[name]) {
|
|
||||||
// throw new Error(`The asset ${name} does not exist in ${manifestPath}`);
|
|
||||||
// }
|
|
||||||
// return manifest[name];
|
|
||||||
// });
|
|
||||||
//
|
|
||||||
// // Copy all images directly to dist.
|
|
||||||
// eleventyConfig.addPassthroughCopy({ "public/img": "img" });
|
|
||||||
//
|
|
||||||
// // Copy the contents of the `public` folder to the output folder
|
|
||||||
// // For example, `./public/css/` ends up in `_site/css/`
|
|
||||||
// // eleventyConfig.addPassthroughCopy({
|
|
||||||
// // "./node_modules/prismjs/themes/prism-okaidia.css": "/public/css/prism-theme.css",
|
|
||||||
// // });
|
|
||||||
// // // Watch our compiled assets for changes
|
|
||||||
// // eleventyConfig.addWatchTarget('./src/compiled-assets/main.css');
|
|
||||||
// // // Copy src/compiled-assets to /assets
|
|
||||||
// // eleventyConfig.addPassthroughCopy({ 'src/compiled-assets': 'assets' });
|
|
||||||
//
|
|
||||||
// // Add plugins
|
|
||||||
// eleventyConfig.addPlugin(pluginRss);
|
|
||||||
// eleventyConfig.addPlugin(pluginSyntaxHighlight);
|
|
||||||
// eleventyConfig.addPlugin(pluginNavigation);
|
|
||||||
// eleventyConfig.addPlugin(EleventyHtmlBasePlugin);
|
|
||||||
//
|
|
||||||
// eleventyConfig.addPlugin(EleventyI18nPlugin, {
|
|
||||||
// defaultLanguage: "fr",
|
|
||||||
// errorMode: "allow-fallback",
|
|
||||||
// });
|
|
||||||
//
|
|
||||||
// eleventyConfig.addFilter("readableDate", (dateObj, format = "dd LLLL yyyy") => {
|
|
||||||
// return DateTime.fromJSDate(dateObj, {zone: 'utc', locale: 'fr'}).toFormat(format);
|
|
||||||
// });
|
|
||||||
//
|
|
||||||
// // https://html.spec.whatwg.org/multipage/common-microsyntaxes.html#valid-date-string
|
|
||||||
// eleventyConfig.addFilter('htmlDateString', (dateObj) => {
|
|
||||||
// return DateTime.fromJSDate(dateObj, {zone: 'utc', locale: 'fr'}).toFormat('yyyy-LL-dd');
|
|
||||||
// });
|
|
||||||
//
|
|
||||||
// // Get the first `n` elements of a collection.
|
|
||||||
// eleventyConfig.addFilter("head", (array, n) => {
|
|
||||||
// if(!Array.isArray(array) || array.length === 0) {
|
|
||||||
// return [];
|
|
||||||
// }
|
|
||||||
// if( n < 0 ) {
|
|
||||||
// return array.slice(n);
|
|
||||||
// }
|
|
||||||
//
|
|
||||||
// return array.slice(0, n);
|
|
||||||
// });
|
|
||||||
//
|
|
||||||
// // Return the smallest number argument
|
|
||||||
// eleventyConfig.addFilter("min", (...numbers) => {
|
|
||||||
// return Math.min.apply(null, numbers);
|
|
||||||
// });
|
|
||||||
//
|
|
||||||
// // Return all the tags used in a collection
|
|
||||||
// eleventyConfig.addFilter("getAllTags", collection => {
|
|
||||||
// let tagSet = new Set();
|
|
||||||
// for(let item of collection) {
|
|
||||||
// (item.data.tags || []).forEach(tag => tagSet.add(tag));
|
|
||||||
// }
|
|
||||||
// return Array.from(tagSet).sort((a, b) => {
|
|
||||||
// return a.localeCompare(b, undefined, {sensitivity: 'base'});
|
|
||||||
// });
|
|
||||||
// });
|
|
||||||
//
|
|
||||||
// eleventyConfig.addFilter("filterTagList", function filterTagList(tags) {
|
|
||||||
// return (tags || []).filter(tag => ["all", "nav", "post", "posts"].indexOf(tag) === -1);
|
|
||||||
// });
|
|
||||||
//
|
|
||||||
// // Customize Markdown library and settings:
|
|
||||||
// eleventyConfig.amendLibrary("md", mdLib => {
|
|
||||||
// mdLib.use(markdownItAnchor, {
|
|
||||||
// permalink: markdownItAnchor.permalink.ariaHidden({
|
|
||||||
// placement: "after",
|
|
||||||
// class: "direct-link",
|
|
||||||
// symbol: "#",
|
|
||||||
// }),
|
|
||||||
// level: [1,2,3,4],
|
|
||||||
// slugify: eleventyConfig.getFilter("slug")
|
|
||||||
// });
|
|
||||||
// });
|
|
||||||
//
|
|
||||||
// // Override @11ty/eleventy-dev-server defaults (used only with --serve)
|
|
||||||
// eleventyConfig.setServerOptions({
|
|
||||||
// showVersion: true,
|
|
||||||
// });
|
|
||||||
//
|
|
||||||
// // i18n filter using Rosetta
|
|
||||||
// const rosettaLib = rosetta(languageStrings);
|
|
||||||
//
|
|
||||||
// eleventyConfig.addFilter("i18n", function (key, lang) {
|
|
||||||
// const I18N_PREFIX = "i18n.";
|
|
||||||
// if(key.startsWith(I18N_PREFIX)) {
|
|
||||||
// key = key.slice(I18N_PREFIX.length);
|
|
||||||
// }
|
|
||||||
// // depends on page.lang in 2.0.0-canary.14+
|
|
||||||
// let page = this.page || this.ctx?.page || this.context?.environments?.page || {};
|
|
||||||
// return rosettaLib.t(key, {}, lang || page.lang);
|
|
||||||
// });
|
|
||||||
//
|
|
||||||
// return {
|
|
||||||
// // Control which files Eleventy will process
|
|
||||||
// // e.g.: *.md, *.njk, *.html, *.liquid
|
|
||||||
// templateFormats: [
|
|
||||||
// "md",
|
|
||||||
// "njk",
|
|
||||||
// "html",
|
|
||||||
// "liquid"
|
|
||||||
// ],
|
|
||||||
//
|
|
||||||
// // Pre-process *.md files with: (default: `liquid`)
|
|
||||||
// markdownTemplateEngine: "njk",
|
|
||||||
//
|
|
||||||
// // Pre-process *.html files with: (default: `liquid`)
|
|
||||||
// htmlTemplateEngine: "njk",
|
|
||||||
//
|
|
||||||
// // -----------------------------------------------------------------
|
|
||||||
// // If your site deploys to a subdirectory, change `pathPrefix`.
|
|
||||||
// // Don’t worry about leading and trailing slashes, we normalize these.
|
|
||||||
//
|
|
||||||
// // If you don’t have a subdirectory, use "" or "/" (they do the same thing)
|
|
||||||
// // This is only used for link URLs (it does not affect your file structure)
|
|
||||||
// // Best paired with the `url` filter: https://www.11ty.dev/docs/filters/url/
|
|
||||||
//
|
|
||||||
// // You can also pass this in on the command line using `--pathprefix`
|
|
||||||
//
|
|
||||||
// // Optional (default is shown)
|
|
||||||
// pathPrefix: "/",
|
|
||||||
// // -----------------------------------------------------------------
|
|
||||||
//
|
|
||||||
// // These are all optional (defaults are shown):
|
|
||||||
// dir: {
|
|
||||||
// input: ".",
|
|
||||||
// includes: "_includes",
|
|
||||||
// data: "_data",
|
|
||||||
// output: "_site"
|
|
||||||
// }
|
|
||||||
// };
|
|
||||||
// };
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue