Skip to content

add mermaid reference, link to docs: #3417

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 23, 2024
Merged

add mermaid reference, link to docs: #3417

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b304083
add mermaid reference, link to docs:
edasmalchi Aug 9, 2024
e332850
format
edasmalchi Aug 9, 2024
7836445
Merge branch 'main' into mermaid-instructions
edasmalchi Aug 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/contribute/content_types.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/publishing/sections/5_analytics_portfolio_site.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Loading