ash-project/ash_hq
1
0
Fork 0
mirror of https://github.com/ash-project/ash_hq.git synced 2024-09-17 03:43:39 +12:00
Code Issues Projects Releases Packages Wiki Activity

feature: Add link to the source for the currently-viewed guide on GitHub

Browse source 
closes #37
This commit is contained in:
Rebecca Le 2023-02-14 14:30:05 +08:00
parent 59fecc19df
commit 4dbc8252bc
No known key found for this signature in database
GPG key ID: F477E2CCB1FC1BA0
2 changed files with 30 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
lib/ash_hq_web/helpers.ex
View file

@ -28,4 +28,8 @@ defmodule AshHqWeb.Helpers do
"https://github.com/#{library.repo_org}/#{library.name}/tree/v#{library_version.version}/#{file}"
end
end
def source_link(%AshHq.Docs.Guide{route: route}, library, library_version) do
"https://github.com/#{library.repo_org}/#{library.name}/tree/v#{library_version.version}/documentation/#{route}.md"
end
end

26
lib/ash_hq_web/pages/docs.ex
View file

@ -112,6 +112,12 @@ defmodule AshHqWeb.Pages.Docs do
library_version={@library_version}
/></h2>
{/if}
<.github_guide_link
:if={@guide}
guide={@guide}
library={@library}
library_version={@library_version}
/>
<.docs doc_path={@doc_path} docs={@docs} />
{#if @extension && !@dsl && !@guide}
{#case Enum.count_until(Stream.filter(@extension.dsls, &(&1.type == :section)), 2)}
@ -307,6 +313,26 @@ defmodule AshHqWeb.Pages.Docs do
"""
end
def github_guide_link(assigns) do
~F"""
<a
href={source_link(@guide, @library, @library_version)}
target="_blank"
class="float-right no-underline mt-1 ml-2 hidden lg:block"
>
<svg
xmlns="http://www.w3.org/2000/svg"
class="w-6 h-6 inline-block mr-1 -mt-1 dark:fill-white fill-base-light-600"
viewBox="0 0 24 24"
>
<path d="M12 0c-6.626 0-12 5.373-12 12 0 5.302 3.438 9.8 8.207 11.387.599.111.793-.261.793-.577v-2.234c-3.338.726-4.033-1.416-4.033-1.416-.546-1.387-1.333-1.756-1.333-1.756-1.089-.745.083-.729.083-.729 1.205.084 1.839 1.237 1.839 1.237 1.07 1.834 2.807 1.304 3.492.997.107-.775.418-1.305.762-1.604-2.665-.305-5.467-1.334-5.467-5.931 0-1.311.469-2.381 1.236-3.221-.124-.303-.535-1.524.117-3.176 0 0 1.008-.322 3.301 1.23.957-.266 1.983-.399 3.003-.404 1.02.005 2.047.138 3.006.404 2.291-1.552 3.297-1.23 3.297-1.23.653 1.653.242 2.874.118 3.176.77.84 1.235 1.911 1.235 3.221 0 4.609-2.807 5.624-5.479 5.921.43.372.823 1.102.823 2.222v3.293c0 .319.192.694.801.576 4.765-1.589 8.199-6.086 8.199-11.386 0-6.627-5.373-12-12-12z" />
</svg>
<span class="underline">View this guide on GitHub</span>
<Heroicons.Outline.ExternalLinkIcon class="w-6 h-6 inline-block -mt-1" />
</a>
"""
end
def docs(assigns) do
~F"""
<div id={docs_container_id(@doc_path)}>