Skip to content

Commit 76ff70b

Browse files
committed
Initial blog engine
1 parent c7e03ae commit 76ff70b

File tree

7 files changed

+93
-0
lines changed

7 files changed

+93
-0
lines changed

.devcontainer/requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ mkdocs-multirepo-plugin==0.6.3
1111
mkdocs-redirects==1.2.1
1212
mkdocs-extra-sass-plugin==0.1.0
1313
mkdocs-render-swagger-plugin==0.1.1
14+
mkdocs-rss-plugin-1.15.0
1415
mkdocs-same-dir==0.1.3
1516
mkdocs-pdf==0.1.1
1617
livereload==2.6.3

blog/.authors.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
authors:
2+
gradleup:
3+
name: GradleUp Team
4+
description: >
5+
GradleUp organizing team
6+
avatar: https://github.com/gradleup.png

blog/images/icon/rss.svg

Lines changed: 4 additions & 0 deletions
Loading

blog/index.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# GradleUp Blog
2+
3+
[RSS feed of created content]({{ config.site_url }}feed_rss_created.xml)
4+
[RSS feed of updated content]({{ config.site_url }}feed_rss_updated.xml)
5+

blog/posts/2024-08-hello-world.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
draft: false
3+
date: 2024-08-12
4+
categories:
5+
- website
6+
- documentation
7+
- mkdocs
8+
authors:
9+
- gradleup
10+
---
11+
12+
# Hello, World!
13+
14+
🐘🎈 GradleUp, a volunteer-driven umbrella GitHub org focused on better Java, Kotlin and Android developer experience with Gradle, got a new website!
15+
16+
<!-- more -->
17+
18+
## What is GradleUp?
19+
20+
GradleUp is a volunteer-driven umbrella GitHub organization
21+
focusing on simplifying developer experience with [Gradle Build Tool (a.k.a. Gradle)](https://gradle.org/),
22+
in particular for Java, Kotlin and Android projects.
23+
We host components and ensure their long-term sustainability.
24+
25+
Our scope includes all things that help to achieve great user and developer experience when working with Gradle.
26+
It includes but not limited to plugins, developer tools, integrations, documentation or community content.
27+
28+
## So, a Website?
29+
30+
The first release includes:
31+
32+
- Listing of the [GradleUp Projects](../../projects/README.md)
33+
- Initial [Governance Charter](../../docs/community/governance.md)
34+
- [Contributing](../../docs/community/participate.md)and
35+
[New Component Hosting](../../docs/community/hosting.md) guidelines.
36+
- And this blog!
37+
38+
## Under the Hood
39+
40+
The site is built with [MkDocs](https://www.mkdocs.org/),
41+
[MkDocs Multirepo Plugin](https://github.com/jdoiro3/mkdocs-multirepo-plugin/tree/main),
42+
and [Material for MkDocs](https://squidfunk.github.io/mkdocs-material).
43+
For development, everything is powered by Dev Containers and GitHub Actions.
44+
As all other resources, the site is open source and open for contributions and new ideas.
45+
Check out the [Contributing Guide](../../CONTRIBUTING.md).
46+
47+
We’re looking forward to establishing the public communication channels, and onboarding more plugins, developer tools and other cool Gradle things.
48+
Adventure is out there!
49+
50+
## Credits
51+
52+
This site is a team effort.
53+
We embed documentation created by many contributors to
54+
[GradleUp Projects](../../projects/README.md).
55+
Also, kudos to [Oleg Nenashev](https://github.com/oleg-nenashev) for working on this website and the community foundations, and welcome to the team!
56+
57+

mkdocs.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@ nav:
3030
- NMCP (New Maven Central Publishing): nmcp/README.md
3131
- Shadow: shadow/README.md
3232
- Hosting New Projects: docs/community/hosting.md
33+
- Blog:
34+
- blog/index.md
3335
- Participate:
3436
- Community Channels: docs/community/participate.md
3537
- GradleUp Team: docs/community/team.md
@@ -45,10 +47,18 @@ nav:
4547
plugins:
4648
- search
4749
- autorefs
50+
- blog
4851
- macros
4952
- mkdocs-pdf
5053
- social
5154
- same-dir
55+
- rss:
56+
match_path: blog/posts/.*
57+
date_from_meta:
58+
as_creation: date
59+
categories:
60+
- categories
61+
- tags
5262
- group:
5363
enabled: !ENV [FULL_BUILD, true]
5464
plugins:
@@ -171,6 +181,9 @@ extra:
171181
- icon: fontawesome/brands/github
172182
link: https://github.com/GradleUp
173183
name: GitHub
184+
- icon: /fontawesome/solid/rss
185+
link: feed_rss_created.xml
186+
name: RSS
174187
# analytics:
175188
# provider: google
176189
# property: TODO

overrides/main.html

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{% extends "base.html" %}
2+
3+
{% block extrahead %}
4+
<!-- RSS Feed -->
5+
<link rel="alternate" type="application/rss+xml" title="RSS feed of created content" href="{{ config.site_url }}feed_rss_created.xml">
6+
<link rel="alternate" type="application/rss+xml" title="RSS feed of updated content" href="{{ config.site_url }}feed_rss_updated.xml">
7+
{% endblock %}

0 commit comments

Comments
 (0)