Skip to content
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.

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

gallery cards are missing #554

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,7 @@ docs/build
docs/src/gallery
docs/src/democards
.vscode/settings.json

docs/node_modules
docs/.DS_Store
docs/package-lock.json
5 changes: 3 additions & 2 deletions docs/Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Colors = "5ae59095-9a9b-59fe-a467-6f913c188581"
DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
DemoCards = "311a05b2-6137-4a5a-b473-18580a3d38b5"
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
DocumenterVitepress = "4710194d-e776-4893-9690-8d956a29c365"
Downloads = "f43a241f-c20a-4ad4-852c-f6b1247861c6"
GeoInterface = "cf35fbd7-0cd7-5166-be24-54bfbe79505f"
GeometryBasics = "5c1252a2-5f33-56bf-86c9-59e7332b4326"
Expand All @@ -18,5 +19,5 @@ Shapefile = "8e980c4a-a4fe-5da2-b3a7-4b4b0353a2f4"
ZipFile = "a5390f91-8eb1-5f08-bee0-b1d1ffed6cea"

[compat]
DemoCards = "0.4.5"
Documenter = "0.27"
DemoCards = "0.5.5"
Documenter = "1.5"
17 changes: 11 additions & 6 deletions docs/make.jl
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
using AlgebraOfGraphics
using Documenter
using DocumenterVitepress
using Literate, Glob
using CairoMakie
using DemoCards
Expand All @@ -20,17 +21,21 @@ gallery, postprocess_cb, gallery_assets = makedemos("gallery")
makedocs(;
modules=[AlgebraOfGraphics],
authors="Pietro Vertechi",
repo="https://github.com/MakieOrg/AlgebraOfGraphics.jl/blob/{commit}{path}#{line}",
repo="https://github.com/MakieOrg/AlgebraOfGraphics.jl",

sitename="Algebra of Graphics",
format=Documenter.HTML(;
prettyurls=get(ENV, "CI", "false") == "true",
assets=["assets/favicon.ico", gallery_assets],
format = DocumenterVitepress.MarkdownVitepress(
repo = "https://github.com/MakieOrg/AlgebraOfGraphics.jl",
),
# format=Documenter.HTML(;
# prettyurls=get(ENV, "CI", "false") == "true",
# assets=["assets/favicon.ico", gallery_assets],
# ),
pages=Any[
"Home" => "index.md",
"Getting Started" => [
"generated/penguins.md",
gallery
# gallery
],
"Algebra of Layers" => [
"layers/introduction.md",
Expand All @@ -49,8 +54,8 @@ makedocs(;
"FAQs.md",
"philosophy.md",
],
strict=true,
)

postprocess_cb() # redirect url for DemoCards generated files

deploydocs(;
Expand Down
17 changes: 17 additions & 0 deletions docs/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"devDependencies": {
"markdown-it": "^14.1.0",
"markdown-it-mathjax3": "^4.3.2",
"vitepress": "^1.1.4",
"vitepress-plugin-tabs": "^0.5.0"
},
"scripts": {
"docs:dev": "vitepress dev build/.documenter",
"docs:build": "vitepress build build/.documenter",
"docs:preview": "vitepress preview build/.documenter"
},
"dependencies": {
"@shikijs/transformers": "^1.1.7",
"markdown-it-footnote": "^4.0.0"
}
}