Skip to content

Commit 9ffd4d2

Browse files
authored
Merge pull request #4254 from mermaid-js/add-latest-news-section
Docs: add Latest News section
2 parents 5d536b9 + 815f4ca commit 9ffd4d2

File tree

9 files changed

+120
-4
lines changed

9 files changed

+120
-4
lines changed

cSpell.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@
4747
"graphviz",
4848
"grav",
4949
"greywolf",
50+
"huynh",
5051
"inkdrop",
5152
"jaoude",
5253
"jison",
@@ -90,6 +91,7 @@
9091
"sidharthv",
9192
"sphinxcontrib",
9293
"statediagram",
94+
"steph",
9395
"stylis",
9496
"substate",
9597
"sveidqvist",

docs/news/announcements.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
> **Warning**
2+
>
3+
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
4+
>
5+
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/news/announcements.md](../../packages/mermaid/src/docs/news/announcements.md).
6+
7+
# Announcements
8+
9+
Stay tuned for some exciting announcements!

docs/news/blog.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
> **Warning**
2+
>
3+
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
4+
>
5+
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/news/blog.md](../../packages/mermaid/src/docs/news/blog.md).
6+
7+
# Blog
8+
9+
## [Automatic text wrapping in flowcharts is here!](https://wwww.mermaidchart.com/blog/posts/automatic-text-wrapping-in-flowcharts-is-here)
10+
11+
3 April 2023 · 3 mins
12+
13+
Markdown Strings reduce the hassle # Starting from v10.
14+
15+
## [Mermaid Chart officially launched with sharable diagram links and presentation mode](https://www.mermaidchart.com/blog/posts/mermaid-chart-officially-launched-with-sharable-diagram-links-and-presentation-mode/)
16+
17+
27 March 2023 · 2 mins
18+
19+
Exciting news for all Mermaid OSS fans: Mermaid Chart has officially launched with Mermaid Chart!
20+
21+
## [If you're not excited about ChatGPT, then you're not being creative](https://www.mermaidchart.com/blog/posts/if-youre-not-excited-about-chatgpt-then-youre-not-being-creative-enough/)
22+
23+
8 March 2023 · 9 mins
24+
25+
The hype around AI in general and ChatGPT, in particular, is so intense that it’s very understandable to assume the hype train is driving straight toward the trough of disillusionment.
26+
27+
## [Flow charts are O(n)2 complex, so don't go over 100 connections](https://www.mermaidchart.com/blog/posts/flow-charts-are-on2-complex-so-dont-go-over-100-connections/)
28+
29+
1 March 2023 · 12 mins
30+
31+
Flowchart design is a game of balance: Read about the importance of dialling in the right level of detail and how to manage complexity in large flowcharts.
32+
33+
## [Busting the myth that developers can't write](https://www.mermaidchart.com/blog/posts/busting-the-myth-that-developers-cant-write/)
34+
35+
10 February 2023 · 10 mins
36+
37+
Busting the myth that developers can’t write # It’s an annoying stereotype that developers don’t know how to write, speak, and otherwise communicate.

docs/public/favicon.ico

11 KB
Binary file not shown.

packages/mermaid/src/docs/.vitepress/config.ts

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,16 @@ export default defineConfig({
2828
},
2929
socialLinks: [
3030
{ icon: 'github', link: 'https://github.com/mermaid-js/mermaid' },
31-
{ icon: 'slack', link: 'https://mermaid-talk.slack.com' },
31+
{
32+
icon: 'slack',
33+
link: 'https://join.slack.com/t/mermaid-talk/shared_invite/enQtNzc4NDIyNzk4OTAyLWVhYjQxOTI2OTg4YmE1ZmJkY2Y4MTU3ODliYmIwOTY3NDJlYjA0YjIyZTdkMDMyZTUwOGI0NjEzYmEwODcwOTE',
34+
},
35+
{
36+
icon: {
37+
svg: '<svg id="Layer_1" data-name="Layer 1" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 490.16 490.16"><defs><mask id="Mask"><rect x="0" y="0" width="490.16" height="490.16" fill="white" /><path fill="black" d="M407.48,111.18A165.2,165.2,0,0,0,245.08,220,165.2,165.2,0,0,0,82.68,111.18a165.5,165.5,0,0,0,72.06,143.64,88.81,88.81,0,0,1,38.53,73.45v50.86H296.9V328.27a88.8,88.8,0,0,1,38.52-73.45,165.41,165.41,0,0,0,72.06-143.64Z"/><path fill="black" d="M160.63,328.27a56.09,56.09,0,0,0-24.27-46.49,198.74,198.74,0,0,1-28.54-23.66A196.87,196.87,0,0,1,82.53,227V379.13h78.1Z"/><path fill="black" d="M329.53,328.27a56.09,56.09,0,0,1,24.27-46.49,198.74,198.74,0,0,0,28.54-23.66A196.87,196.87,0,0,0,407.63,227V379.13h-78.1Z"/></mask><style>.cls-1{fill:#76767B;}.cls-1:hover{fill:#FF3570}</style></defs><rect class="cls-1" width="490.16" height="490.16" rx="84.61" mask="url(#Mask)" /></svg>',
38+
},
39+
link: 'https://www.mermaidchart.com/',
40+
},
3241
],
3342
},
3443
});
@@ -42,6 +51,11 @@ function nav() {
4251
activeMatch: '/config/',
4352
},
4453
{ text: 'Integrations', link: '/ecosystem/integrations', activeMatch: '/ecosystem/' },
54+
{
55+
text: 'Latest News',
56+
link: '/news/announcements',
57+
activeMatch: '/announcements',
58+
},
4559
{
4660
text: version,
4761
items: [
@@ -80,6 +94,7 @@ function sidebarAll() {
8094
...sidebarEcosystem(),
8195
...sidebarConfig(),
8296
...sidebarCommunity(),
97+
...sidebarNews(),
8398
];
8499
}
85100

@@ -162,3 +177,16 @@ function sidebarCommunity() {
162177
},
163178
];
164179
}
180+
181+
function sidebarNews() {
182+
return [
183+
{
184+
text: '📰 Latest News',
185+
collapsible: true,
186+
items: [
187+
{ text: 'Announcements', link: '/news/announcements' },
188+
{ text: 'Blog', link: '/news/blog' },
189+
],
190+
},
191+
];
192+
}

packages/mermaid/src/docs/index.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,15 @@ features:
2323
- title: ➕ Easy to use!
2424
details: Easily create and render detailed diagrams and charts with the Mermaid Live Editor.
2525
link: https://mermaid.live/
26-
- title: 🎥 Video Tutorials!
27-
details: Curated list of video tutorials and examples created by the community.
28-
link: ../../config/Tutorials.html
2926
- title: 🧩 Integrations available!
3027
details: Use Mermaid with your favorite applications, check out the integrations list.
3128
link: ../../ecosystem/integrations.md
3229
- title: 🏆 Award winning!
3330
details: 2019 JavaScript Open Source Award winner for "The Most Exciting Use of Technology".
3431
link: https://osawards.com/javascript/2019
32+
- title: 🥰 Mermaid + Mermaid Chart
33+
details: Mermaid Chart is a major supporter of the Mermaid project.
34+
link: https://www.mermaidchart.com/
3535
---
3636

3737
<script setup>
@@ -149,6 +149,12 @@ const members = [
149149
title: "Developer",
150150
links: [{ icon: "github", link: "https://github.com/spopida" }],
151151
},
152+
{
153+
avatar: "https://avatars.githubusercontent.com/u/35910788?v=4",
154+
name: "Steph Huynh",
155+
title: "Developer",
156+
links: [{ icon: "github", link: "https://github.com/huynhicode" }],
157+
},
152158
];
153159

154160
</script>
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Announcements
2+
3+
Stay tuned for some exciting announcements!
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Blog
2+
3+
## [Automatic text wrapping in flowcharts is here!](https://wwww.mermaidchart.com/blog/posts/automatic-text-wrapping-in-flowcharts-is-here)
4+
5+
3 April 2023 · 3 mins
6+
7+
Markdown Strings reduce the hassle # Starting from v10.
8+
9+
## [Mermaid Chart officially launched with sharable diagram links and presentation mode](https://www.mermaidchart.com/blog/posts/mermaid-chart-officially-launched-with-sharable-diagram-links-and-presentation-mode/)
10+
11+
27 March 2023 · 2 mins
12+
13+
Exciting news for all Mermaid OSS fans: Mermaid Chart has officially launched with Mermaid Chart!
14+
15+
## [If you're not excited about ChatGPT, then you're not being creative](https://www.mermaidchart.com/blog/posts/if-youre-not-excited-about-chatgpt-then-youre-not-being-creative-enough/)
16+
17+
8 March 2023 · 9 mins
18+
19+
The hype around AI in general and ChatGPT, in particular, is so intense that it’s very understandable to assume the hype train is driving straight toward the trough of disillusionment.
20+
21+
## [Flow charts are O(n)2 complex, so don't go over 100 connections](https://www.mermaidchart.com/blog/posts/flow-charts-are-on2-complex-so-dont-go-over-100-connections/)
22+
23+
1 March 2023 · 12 mins
24+
25+
Flowchart design is a game of balance: Read about the importance of dialling in the right level of detail and how to manage complexity in large flowcharts.
26+
27+
## [Busting the myth that developers can't write](https://www.mermaidchart.com/blog/posts/busting-the-myth-that-developers-cant-write/)
28+
29+
10 February 2023 · 10 mins
30+
31+
Busting the myth that developers can’t write # It’s an annoying stereotype that developers don’t know how to write, speak, and otherwise communicate.
11 KB
Binary file not shown.

0 commit comments

Comments
 (0)