Skip to content

Commit

Permalink
Merge branch 'main' into reference-gen-use-jsr-deno_doc
Browse files Browse the repository at this point in the history
# Conflicts:
#	.github/workflows/deploy.yml
  • Loading branch information
crowlKats committed Nov 21, 2024
2 parents a9bb8d4 + 3e68c94 commit 239689e
Show file tree
Hide file tree
Showing 26 changed files with 642 additions and 943 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
_site
_cache
_broken_links.json

.idea

Expand Down
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,10 @@ Static files (like screenshots) can be included directly in the `runtime`,
## Reference docs

The reference docs served at `/api` are generated via the `deno doc` subcommand.
To generate the reference docs locally, in the `reference_gen` directory, run:
To generate the reference docs locally, run:

```console
deno task types
deno task doc
deno task reference
```

This will generate the reference docs, and you can use the `serve` or `build`
Expand Down
8 changes: 8 additions & 0 deletions _config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import redirects from "lume/plugins/redirects.ts";
import search from "lume/plugins/search.ts";
import sitemap from "lume/plugins/sitemap.ts";
import postcss from "lume/plugins/postcss.ts";
import checkUrls from "lume/plugins/check_urls.ts";

import tw from "tailwindcss";
import tailwindConfig from "./tailwind.config.js";
Expand Down Expand Up @@ -272,6 +273,13 @@ site.ignore(
);

site.scopedUpdates((path) => path == "/overrides.css");
site.use(checkUrls({
external: false, // Set to true to check external links
output: "_broken_links.json",
ignore: [
"https://www.googletagmanager.com",
],
}));

site.remoteFile(
"orama.css",
Expand Down
6 changes: 4 additions & 2 deletions deno.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,18 @@
"@std/fs": "jsr:@std/fs@^0.229.3",
"@std/media-types": "jsr:@std/media-types@^1.0.3",
"ga4": "https://raw.githubusercontent.com/denoland/ga4/04a1ce209116f158b5ef1658b957bdb109db68ed/mod.ts",
"lume/": "https://deno.land/x/[email protected]/",
"@orama/wc-components/": "https://unpkg.com/@orama/[email protected]/",
"googleapis": "npm:googleapis@^144.0.0",
"lume/": "https://deno.land/x/[email protected]/",
"tailwindcss": "npm:tailwindcss@^3.4.9"
},
"tasks": {
"build": "deno run -A lume.ts",
"serve": "deno run -A lume.ts -s",
"debug": "deno task build && deno task prod",
"prod": "cd _site && deno run --allow-read --allow-env --allow-net server.ts",
"reference": "cd reference_gen && deno task types && deno task doc"
"reference": "cd reference_gen && deno task types && deno task doc",
"lume": "echo \"import 'lume/cli.ts'\" | deno run -A -"
},
"compilerOptions": {
"types": [
Expand Down
Loading

0 comments on commit 239689e

Please sign in to comment.