Skip to content

Commit

Permalink
update docs and examples
Browse files Browse the repository at this point in the history
  • Loading branch information
cormullion committed May 8, 2022
1 parent 24dffdb commit c73db75
Show file tree
Hide file tree
Showing 19 changed files with 744 additions and 168 deletions.
20 changes: 8 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,17 @@
| [![][docs-development-img]][docs-development-url] | |

Karnak.jl is a small extension for the Luxor.jl package to
help with constructing graph-style drawings.
help with visualizing graphs and networks.

Karnak relies on [Graphs.jl](https://github.com/JuliaGraphs/Graphs.jl) for graph construction, and
on [NetworkLayout.jl](https://juliagraphs.org/NetworkLayout.jl/) for graph layout.
Karnak also relies on
[Graphs.jl](https://github.com/JuliaGraphs/Graphs.jl) for
graph construction, and on
[NetworkLayout.jl](https://juliagraphs.org/NetworkLayout.jl/)
for graph layout.

The focus in Karnak, unlike other graph visualization
packages, is on decorative and aesthetic uses, for use in
design, generative art, social media previews, NFTs, and
other mission-critical items, rather than on
scientific rigor and mathematical elegance. So...
## See also

## Warning

For scientific and technical visualization, use one of
the following Julia packages to visualize your graphs:
There's a good selection of Julia packages for visualizing graphs:

- [TikzGraphs.jl](https://github.com/sisl/TikzGraphs.jl): backend: Tikz/Latex

Expand Down
16 changes: 8 additions & 8 deletions docs/src/assets/styles.css
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
@font-face {
font-family: JuliaMono-Light;
src:
local('JuliaMono-Light'),
url("https://github.com/cormullion/juliamono/raw/master/webfonts/JuliaMono-Light.woff2");
font-family: JuliaMono-Light;
src:
local('JuliaMono-Light'),
url("https://github.com/cormullion/juliamono/raw/master/webfonts/JuliaMono-Light.woff2");
}

pre, code {
font-family: JuliaMono !important;
font-family: JuliaMono !important;
font-feature-settings: "calt" 1;
}

Expand All @@ -28,14 +28,14 @@ p > a:after {
}

html.theme--documenter-dark p > code {
color: #eff !important;
color: #eff !important;
}

html.theme--documenter-dark li > code {
color: #eff !important;
color: #eff !important;
}


html.theme--documenter-dark a > code {
color: #eff !important;
color: #eff !important;
}
5 changes: 3 additions & 2 deletions docs/src/basics.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,9 @@ of programming in Julia.
pages are built by Documenter.jl, and the code to draw
them is included here. SVG is used because it's good for
line drawings, but you can use `drawgraph()` in any
Luxor environment, such as PNG - recommended as the
drawings get very complex, since large SVGs can tax browsers.
Luxor environment, such as PNG - which is the
recommended format to use as the drawings get very
complex, since large SVGs can tax web browsers.

## Graphs, vertices, and edges

Expand Down
Loading

0 comments on commit c73db75

Please sign in to comment.