|
1 | | -# Eleventy LibDoc |
| 1 | +# bodnar.dev |
2 | 2 |
|
3 | | -[Eleventy LibDoc website](https://eleventy-libdoc.netlify.app/) | [11ty website](11ty) |
| 3 | +Personal website and portfolio for Daniel Bodnar - Platform Engineer, Systems Architect, SRE, and Linux Evangelist. |
4 | 4 |
|
5 | | -Eleventy LibDoc is an easy to use and content focused starter project for [Eleventy][11ty] to craft slick and responsive documentation. It was was developed with accessibility awareness and low-tech mindset which allows to reach good page speed performances. It contains vanilla JS self-made components like search, primary navigation, table of content, code highlighting and sandboxes. Every page created with LibDoc is printable and can work properly even without Javascript by maintaining only essential features. |
| 5 | +## Overview |
6 | 6 |
|
7 | | -[](https://app.netlify.com/sites/11ty-libdoc-blank/deploys) |
| 7 | +This site is built with [Eleventy](https://www.11ty.dev/) (11ty), a simple and powerful static site generator. It's fast, minimal, and easy to maintain. |
8 | 8 |
|
9 | | - |
| 9 | +## Pages |
10 | 10 |
|
11 | | -<img width="1471" height="625" alt="image" src="https://github.com/user-attachments/assets/9af60d6f-8d5b-463e-9570-b5a6e54a8515" /> |
12 | | -<img width="1461" height="617" alt="image" src="https://github.com/user-attachments/assets/f37bbe07-f65a-4a4f-acb1-6892ec202aac" /> |
| 11 | +- **Home** - Landing page with quick overview |
| 12 | +- **About** - Full professional profile |
| 13 | +- **Resume** - Complete CV with work history |
| 14 | +- **Experience** - Detailed timeline of professional experience |
| 15 | +- **Skills** - Technical expertise breakdown |
| 16 | +- **Tech Stacks** - Preferred tool combinations |
| 17 | +- **Bookmarks** - Curated resources |
| 18 | +- **Awesome Lists** - Meta-collection of awesome lists |
13 | 19 |
|
14 | | -> [!NOTE] |
15 | | -> Eleventy LibDoc is still under active development and therefore before reaching v1.0.0: |
16 | | -> * Full backward compatibility is not guaranteed. |
17 | | -> * Many features are subject to change. |
| 20 | +## Getting Started |
18 | 21 |
|
19 | | -## Getting started |
| 22 | +### Prerequisites |
20 | 23 |
|
21 | | -1. Clone or fork <https://github.com/ita-design-system/eleventy-libdoc> |
22 | | -2. Run `npm install` |
23 | | -3. Enter your own settings in `settings.json`. [Configuration](https://eleventy-libdoc.netlify.app/configuration/). |
24 | | -4. Build `npx @11ty/eleventy --serve` or `npx @11ty/eleventy` (if you already have your own web server). |
| 24 | +- Node.js 18+ or Bun |
25 | 25 |
|
26 | | -[View deployment of this repository](https://11ty-libdoc-blank.netlify.app) |
| 26 | +### Installation |
27 | 27 |
|
28 | | -## Key features |
| 28 | +```bash |
| 29 | +# Clone the repository |
| 30 | +git clone https://github.com/danielbodnar/bodnar.dev |
29 | 31 |
|
30 | | -* **Content focused** <br>LibDoc is easy to install, deploy and use. |
31 | | -* **Accessibility** <br>LibDoc was developed with accessibility awareness. |
32 | | -* **Performance** <br>Low front-end dependencies and vanilla JS self-made components make LibDoc cross-browser compatibility and good performances. <a href="https://developers.google.com/speed/pagespeed/insights/?url=eleventy-libdoc.netlify.app" target="_blank">View performances</a>. |
33 | | -* **Search** <br>Fuzzy and standard search modes. Keyboard shortcut 🆂 allows quick focus on search input field. Fuzzy search makes easy keyboard based navigation whereas standard search allows to find an exact match.. |
34 | | -* **Smart navigation** <br>On page change, the primary navigation menu keeps its position. |
35 | | -* **Smart table of content** <br>In addition of a pure static table of content, LibDoc generates a floating <abbr title="Table of Content">TOC</abbr> always visible that also displays the current window scroll position. |
36 | | -* **Fallback if no Javascript available** <br>LibDoc can work even without Javascript with reduced features. |
37 | | -* **Image transcoding** <br>LibDoc transcodes and resizes your source images into production ready formats. |
38 | | -* **Printable** <br>Every page created with LibDoc can be printed. |
39 | | -* **Light and dark modes** <br>LibDoc’s interface is available with both light and dark mode color schemes. |
40 | | -* **Slick code highlighting** <br>Display your code in a nice style and adjust which code languages you really use. |
41 | | -* **Sandboxes** <br>Showcase small demos or full HTML pages into a responsive dual pane. |
42 | | -* **Atom feed** <br>The Atom feed allows visitors to subscribe to post blog content. |
| 32 | +# Install dependencies |
| 33 | +bun install |
| 34 | +# or |
| 35 | +npm install |
| 36 | +``` |
43 | 37 |
|
44 | | -## Documentation |
| 38 | +### Development |
45 | 39 |
|
46 | | -* [LibDoc’s homepage](https://eleventy-libdoc.netlify.app) <br>The website containing LibDocs’s presentation and comprehensive documentation. |
47 | | - * [Configuration](https://eleventy-libdoc.netlify.app/configuration/) <br>List and descriptions of every LibDoc parameter. |
48 | | - * [Creating content](https://eleventy-libdoc.netlify.app/creating-content/) <br>How LibDoc can display your content in multiple ways. |
49 | | - * [Front matter](https://eleventy-libdoc.netlify.app/front-matter/) <br>Documentation of all front matter settings related to a LibDoc page. |
50 | | - * [Primary navigation](https://eleventy-libdoc.netlify.app/primary-navigation/) <br>Detailed features of LibDoc’s primary navigation. |
51 | | - * [SEO](https://eleventy-libdoc.netlify.app/configuration/seo/) <br>How LibDoc’s configuration and pages parameters are applied for Search Engine Optimization. |
52 | | - * [Credits](https://eleventy-libdoc.netlify.app/configuration/credits/) <br>LibDoc could not work without these resources. |
| 40 | +```bash |
| 41 | +# Start development server |
| 42 | +bun run dev |
| 43 | +# or |
| 44 | +npm run dev |
| 45 | +``` |
53 | 46 |
|
54 | | -[11ty]: https://www.11ty.dev/ |
| 47 | +### Build |
| 48 | + |
| 49 | +```bash |
| 50 | +# Build for production |
| 51 | +bun run build |
| 52 | +# or |
| 53 | +npm run build |
| 54 | +``` |
| 55 | + |
| 56 | +## Configuration |
| 57 | + |
| 58 | +Edit `settings.json` to customize: |
| 59 | + |
| 60 | +- Site title and description |
| 61 | +- Author information |
| 62 | +- Custom links (GitHub, LinkedIn, etc.) |
| 63 | +- Blog settings |
| 64 | + |
| 65 | +## Project Structure |
| 66 | + |
| 67 | +``` |
| 68 | +bodnar.dev/ |
| 69 | +├── _data/ # Global data files |
| 70 | +├── _includes/ # Layout templates |
| 71 | +├── core/ # Core assets (CSS, JS, fonts) |
| 72 | +├── *.md # Content pages |
| 73 | +├── settings.json # Site configuration |
| 74 | +├── package.json # Project dependencies |
| 75 | +└── README.md # This file |
| 76 | +``` |
| 77 | + |
| 78 | +## Content |
| 79 | + |
| 80 | +All page content is sourced from: |
| 81 | +- `./bodnar.sh/PROFILE.md` - Professional profile |
| 82 | +- `./bodnar.sh/danielbodnar.resume.v2023.md` - Resume content |
| 83 | +- `./bodnar.sh/src/components/*.tsx` - Skills and experience data |
| 84 | + |
| 85 | +## Contact |
| 86 | + |
| 87 | + |
| 88 | +- **GitHub:** [@danielbodnar](https://github.com/danielbodnar) |
| 89 | +- **LinkedIn:** [danielbodnar](https://linkedin.com/in/danielbodnar) |
| 90 | +- **Website:** [bodnar.sh](https://bodnar.sh) |
| 91 | + |
| 92 | +## License |
| 93 | + |
| 94 | +MIT |
0 commit comments