Skip to content

Commit f145374

Browse files
committed
update README
1 parent 196d814 commit f145374

File tree

1 file changed

+52
-40
lines changed

1 file changed

+52
-40
lines changed

README.md

Lines changed: 52 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,62 @@ This website is built with [11ty (Eleventy)](https://www.11ty.dev/), a static si
1111
- **InvenioILS**: An integrated library system for modern libraries
1212
- **Community**: Resources, documentation, events, and support for the Invenio ecosystem
1313

14-
## Requirements
14+
## Content Management
15+
16+
### Adding Blog Posts
17+
18+
1. Create a new markdown file in `src/blog-posts/`
19+
2. Use the naming convention: `YYYY-MM-DD-post-title.md`
20+
3. Add:
21+
22+
```yaml
23+
---
24+
title: "Your Blog Post Title"
25+
author: Author Name
26+
date: YYYY-MM-DD
27+
team: Invenio
28+
permalink: "/blog/YYYY-MM-DD-post-title/"
29+
---
30+
31+
Your blog content here...
32+
```
33+
34+
### Adding Images
35+
36+
Place images in `src/assets/images/` and reference them in markdown:
37+
38+
```markdown
39+
![Alt text](image-filename.png)
40+
```
41+
42+
### Update Roadmap
43+
44+
The Roadmap is automatically updated at every deployment, and it is a screenshot of the
45+
[GitHub Board](https://github.com/orgs/inveniosoftware/projects/80).
46+
47+
Tu update it, trigger a new deployment in GitHub:
48+
49+
1. Go to the [GitHub repository](https://github.com/inveniosoftware/inveniosoftware.org).
50+
2. Click on [Actions](https://github.com/inveniosoftware/inveniosoftware.org/actions).
51+
3. On the left menu, click on [Deploy to GitHub Pages](https://github.com/inveniosoftware/inveniosoftware.org/actions/workflows/deploy.yml).
52+
4. Click on the right button `Run workflow`.
53+
54+
### Site Configuration
55+
56+
Main configuration is in `eleventy.config.js`:
57+
58+
- **Input**: `src/` directory
59+
- **Output**: `_site/` directory
60+
- **Template formats**: Markdown, Nunjucks, HTML, Liquid, JS
61+
- **Asset copying**: Images are copied to build output
62+
63+
## Develop
64+
65+
### Requirements
1566

1667
- **Node.js** (v18 or higher)
1768
- **npm**
1869

19-
## Getting Started
20-
2170
### 1. Clone the Repository
2271

2372
```bash
@@ -59,43 +108,6 @@ The built site will be in the `_site/` directory.
59108
| `npm run build` | Build site for production (includes screenshot generation) |
60109
| `npm run debug` | Start server with detailed Eleventy debug information |
61110

62-
## Content Management
63-
64-
### Adding Blog Posts
65-
66-
1. Create a new markdown file in `src/blog-posts/`
67-
2. Use the naming convention: `YYYY-MM-DD-post-title.md`
68-
3. Add frontmatter with required fields:
69-
70-
```yaml
71-
---
72-
title: "Your Blog Post Title"
73-
author: Author Name
74-
date: YYYY-MM-DD
75-
team: Invenio
76-
permalink: "/blog/YYYY-MM-DD-post-title/"
77-
---
78-
79-
Your blog content here...
80-
```
81-
82-
### Adding Images
83-
84-
Place images in `src/assets/images/` and reference them in markdown:
85-
86-
```markdown
87-
![Alt text](image-filename.png)
88-
```
89-
90-
### Site Configuration
91-
92-
Main configuration is in `eleventy.config.js`:
93-
94-
- **Input**: `src/` directory
95-
- **Output**: `_site/` directory
96-
- **Template formats**: Markdown, Nunjucks, HTML, Liquid, JS
97-
- **Asset copying**: Images are copied to build output
98-
99111
## Deployment
100112

101113
### GitHub Pages (Automatic)

0 commit comments

Comments
 (0)