diff --git a/README.md b/README.md index 30cd00ee..e9fc3116 100644 --- a/README.md +++ b/README.md @@ -121,7 +121,7 @@ If this is a one-time submission and you don't want to bother, you can just add The excerpt is a small description of the guide content that will show on the guide list so users can have a glimpse of what the guide is about. Be clear and concise! -Images go under [`src/images`](https://github.com/bump-sh/docs/tree/main/src/images) and can be called with `![](/images/guides/)`. +Images go under [`src/docs/images`](https://github.com/bump-sh/docs/tree/main/src/docs/images) and can be called with `![](/docs/images/guides/)`. ##### Gotchas * Ordered lists: if you need to any kind of blocks in your ordered list item, make sure it immediately follows the numbered paragraph line (no empty line in between). You might also want to [indent your block to line up with the first non-space character after the list item marker](https://stackoverflow.com/questions/34987908/embed-a-code-block-in-a-list-item-with-proper-indentation-in-kramdown). Just do both for safety! diff --git a/bridgetown.config.yml b/bridgetown.config.yml index 57099d74..b53528c8 100644 --- a/bridgetown.config.yml +++ b/bridgetown.config.yml @@ -25,9 +25,10 @@ template_engine: erb include: ["_redirects"] metadata: - favicon_light: "/images/favicon.svg" - favicon_dark: "/images/favicon-dark.svg" + favicon_light: "/docs/images/favicon.svg" + favicon_dark: "/docs/images/favicon-dark.svg" +keep_files: ["docs"] # Other options you might want to investigate: # # base_path: "/" # the subpath of your site, e.g. /blog. If you set this option, diff --git a/esbuild.config.js b/esbuild.config.js index 5df3ccd9..934a8115 100644 --- a/esbuild.config.js +++ b/esbuild.config.js @@ -40,7 +40,11 @@ const esbuildOptions = { ], globOptions: { excludeFilter: /\.(dsd|lit)\.css$/ - } + }, + bridgetownConfig: { + destination: "output/docs", + }, + publicPath: "/docs/_bridgetown/static", } build(esbuildOptions) diff --git a/frontend/styles/atoms/blockquote.css b/frontend/styles/atoms/blockquote.css index 5f8f37d6..91bd2393 100644 --- a/frontend/styles/atoms/blockquote.css +++ b/frontend/styles/atoms/blockquote.css @@ -1,7 +1,7 @@ :where(blockquote) { --callout-bg-color: var(--bg-color-secondary); --callout-border-color: var(--border-color-default); - --callout-icon-path: url(/images/icons/info.svg); + --callout-icon-path: url(/docs/images/icons/info.svg); border-left: 3px solid var(--border-color-default); margin-inline: 0; padding: var(--spacing-1) var(--spacing-3); @@ -19,7 +19,7 @@ &:where(.info, .success, .warning, .error) { --callout-bg-color: var(--bg-color-secondary); --callout-border-color: var(--border-color-default); - --callout-icon-path: url(/images/icons/info.svg); + --callout-icon-path: url(/docs/images/icons/info.svg); background-color: var(--callout-bg-color); border-left: 4px solid var(--callout-border-color); @@ -45,25 +45,25 @@ &.info { --callout-bg-color: var(--bg-color-info); --callout-border-color: var(--text-color-info); - --callout-icon-path: url(/images/icons/info.svg); + --callout-icon-path: url(/docs/images/icons/info.svg); } &.success { --callout-bg-color: var(--bg-color-success); --callout-border-color: var(--text-color-success); - --callout-icon-path: url(/images/icons/success.svg); + --callout-icon-path: url(/docs/images/icons/success.svg); } &.warning { --callout-bg-color: var(--bg-color-warning); --callout-border-color: var(--text-color-warning); - --callout-icon-path: url(/images/icons/warning.svg); + --callout-icon-path: url(/docs/images/icons/warning.svg); } &.error { --callout-bg-color: var(--bg-color-error); --callout-border-color: var(--text-color-error); - --callout-icon-path: url(/images/icons/error.svg); + --callout-icon-path: url(/docs/images/icons/error.svg); } } } diff --git a/frontend/styles/components/search.css b/frontend/styles/components/search.css index df22be4a..7d45bd7d 100644 --- a/frontend/styles/components/search.css +++ b/frontend/styles/components/search.css @@ -1,6 +1,6 @@ bridgetown-search-form { input[type="search"] { - background: var(--bg-color) url(/images/icons/search.svg) left var(--spacing-3) center no-repeat; + background: var(--bg-color) url(/docs/images/icons/search.svg) left var(--spacing-3) center no-repeat; width: 100%; padding-left: var(--spacing-9); } diff --git a/src/_components/guides/authors/card.erb b/src/_components/guides/authors/card.erb index e64515d4..50f9bd21 100644 --- a/src/_components/guides/authors/card.erb +++ b/src/_components/guides/authors/card.erb @@ -13,12 +13,12 @@
<% if @author.email.present? %> "> - <%= svg "images/icons/mail.svg" %> + <%= svg "/docs/images/icons/mail.svg" %> <% end %> <% if @author.github.present? %> - <%= svg "images/icons/github.svg" %> + <%= svg "/docs/images/icons/github.svg" %> <% end %>
diff --git a/src/_components/guides/in_depth/post_info.erb b/src/_components/guides/in_depth/post_info.erb index a2f7a3ea..a817a010 100644 --- a/src/_components/guides/in_depth/post_info.erb +++ b/src/_components/guides/in_depth/post_info.erb @@ -5,7 +5,7 @@ <%= author_name(author) %> <% if !is_guest?(author) && github_link(author).present? %> <%= link_to github_link(author), "aria-label": "Go to GitHub" do %> - <%= svg "images/icons/github.svg" %> + <%= svg "/docs/images/icons/github.svg" %> <% end %> <% end %> <% end %> diff --git a/src/_components/guides/list.erb b/src/_components/guides/list.erb index 9b52f079..661a277a 100644 --- a/src/_components/guides/list.erb +++ b/src/_components/guides/list.erb @@ -12,7 +12,7 @@ <% if @remaining_count > 0 %> " class="card browse-all"> Browse <%= @remaining_count %> more guides - <%= svg "images/icons/arrow-right-circle.svg" %> + <%= svg "/docs/images/icons/arrow-right-circle.svg" %> <% end %> diff --git a/src/_components/guides/version_selector.erb b/src/_components/guides/version_selector.erb index da2bde8d..d4a3663c 100644 --- a/src/_components/guides/version_selector.erb +++ b/src/_components/guides/version_selector.erb @@ -2,7 +2,7 @@
<% @site.data.footer.social.each do |entry| %> - " alt="<%= entry.label %>" /> + " alt="<%= entry.label %>" /> <% end %>
diff --git a/src/_components/shared/navbar.erb b/src/_components/shared/navbar.erb index 5fed3bcb..0f10a75d 100644 --- a/src/_components/shared/navbar.erb +++ b/src/_components/shared/navbar.erb @@ -1,6 +1,6 @@
- Bump.sh + Bump.sh