add mermaid reference, link to docs: (#3417)

* add mermaid reference, link to docs: * format
cal-itp · Aug 23, 2024 · 219319c · 219319c
1 parent 4dd2310
commit 219319c
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/docs/contribute/content_types.md b/docs/contribute/content_types.md
@@ -27,6 +27,7 @@ Below we've provided some examples of commons types of content for quick use. To
    - [SQL](executing-code-sql)
 3. [Non-executing Code](non-executing-code)
 4. [Internal References and Cross References](internal-refs)
+5. Need a node graph to illustrate a complex flow or process? Try mermaid ([documentation here](https://mermaid.js.org/intro/)).
    (executing-code)=
 
 ### Executing Code

diff --git a/docs/publishing/sections/5_analytics_portfolio_site.md b/docs/publishing/sections/5_analytics_portfolio_site.md
@@ -41,6 +41,7 @@ Create a `README.md` file in the repo where your work lies. This also forms the
   - `git rm portfolio/my_analysis/README_accidentally_named_something_else.md`
   - `rm portfolio/my_analysis/_build/html/README_accidentally_named_something.html`. We use `rm` because \_build/html folder is not checked into GitHub
   - `python portfolio/portfolio.py build my_report --no-execute-papermill --deploy` to rerun the portfolio to incorporate only the new changes to your `README.md` if the other pages are correct.
+- Need a node graph to illustrate where your data comes from and how it's processed? Try mermaid ([documentation here](https://mermaid.js.org/intro/)). See published [GTFS Digest](https://gtfs-digest--cal-itp-data-analyses.netlify.app/readme) for a current example.
 
 ### YML