api docs with links

app/components/content/ApiCard.vue

@@ -5,7 +5,8 @@ defineProps(['object', 'category'])
 <template>
     <div
         class="block max-w-xm p-6 bg-white border border-gray-200 rounded-lg shadow hover:bg-gray-100 dark:bg-gray-800 dark:border-gray-700 dark:hover:bg-gray-700">
-        <span class="mb-2 text-xl font-bold tracking-tight text-gray-900 dark:text-white">{{ object }}</span> -
+      <a style="display:block;position:relative;top:-100px;visibility:hidden" :id="object"></a>
+        <a class="mb-2 text-xl font-bold tracking-tight text-gray-900 dark:text-white" :href="'#'+object">{{ object }}</a> -
         <span>{{ category }}</span>
         <div class="font-normal text-gray-700 dark:text-gray-400">
             <ContentSlot :use="$slots.docstring" unwrap="div">

content/2.framework/2.genie.jl/4.Plugins/GenieAuthentication/genieauthentication.md

@@ -1,122 +1,175 @@
 
 
-::ApiCard{object="GenieAuthentication.GenieAuthentication" category="Module"}
+::ApiCard{object='GenieAuthentication.GenieAuthentication' category='Module'}
 #docstring
 
 
+
 Functionality for authenticating Genie users.
 
+
+[source](https://github.com/GenieFramework/GenieAuthentication.jl/blob/v2.2.0/src/GenieAuthentication.jl#L1-L3)
+
 ::
-::ApiCard{object="GenieAuthentication.authenticate-Tuple{Any, GenieSession.Session}" category="Method"}
+::ApiCard{object='GenieAuthentication.authenticate-Tuple{Any, GenieSession.Session}' category='Method'}
 #docstring
 
 
+
 Stores the user id on the session.
 
+
+[source](https://github.com/GenieFramework/GenieAuthentication.jl/blob/v2.2.0/src/GenieAuthentication.jl#L20-L22)
+
 ::
-::ApiCard{object="GenieAuthentication.deauthenticate-Tuple{GenieSession.Session}" category="Method"}
+::ApiCard{object='GenieAuthentication.deauthenticate-Tuple{GenieSession.Session}' category='Method'}
 #docstring
 
 
+
 ```julia
 deauthenticate(session)
 deauthenticate(params::Dict{Symbol,Any})
 ```
 
+
 Removes the user id from the session.
 
+
+[source](https://github.com/GenieFramework/GenieAuthentication.jl/blob/v2.2.0/src/GenieAuthentication.jl#L34-L39)
+
 ::
-::ApiCard{object="GenieAuthentication.get_authentication-Tuple{GenieSession.Session}" category="Method"}
+::ApiCard{object='GenieAuthentication.get_authentication-Tuple{GenieSession.Session}' category='Method'}
 #docstring
 
 
+
 ```julia
 get_authentication(session) :: Union{Nothing,Any}
 get_authentication(params::Dict{Symbol,Any}) :: Union{Nothing,Any}
 ```
 
+
 Returns the user id stored on the session, if available.
 
+
+[source](https://github.com/GenieFramework/GenieAuthentication.jl/blob/v2.2.0/src/GenieAuthentication.jl#L89-L94)
+
 ::
-::ApiCard{object="GenieAuthentication.install-Tuple{String}" category="Method"}
+::ApiCard{object='GenieAuthentication.install-Tuple{String}' category='Method'}
 #docstring
 
 
+
 ```julia
 install(dest::String; force = false, debug = false) :: Nothing
 ```
 
-Copies the plugin's files into the host Genie application.
+
+Copies the plugin's files into the host Genie application.
+
+
+[source](https://github.com/GenieFramework/GenieAuthentication.jl/blob/v2.2.0/src/GenieAuthentication.jl#L165-L169)
 
 ::
-::ApiCard{object="GenieAuthentication.is_authenticated-Tuple{Union{Nothing, GenieSession.Session}}" category="Method"}
+::ApiCard{object='GenieAuthentication.is_authenticated-Tuple{Union{Nothing, GenieSession.Session}}' category='Method'}
 #docstring
 
 
+
 ```julia
 is_authenticated(session) :: Bool
 is_authenticated(params::Dict{Symbol,Any}) :: Bool
 ```
 
+
 Returns `true` if a user id is stored on the session.
 
+
+[source](https://github.com/GenieFramework/GenieAuthentication.jl/blob/v2.2.0/src/GenieAuthentication.jl#L48-L53)
+
 ::
-::ApiCard{object="GenieAuthentication.login-Union{Tuple{M}, Tuple{M, GenieSession.Session}} where M<:SearchLight.AbstractModel" category="Method"}
+::ApiCard{object='GenieAuthentication.login-Union{Tuple{M}, Tuple{M, GenieSession.Session}} where M<:SearchLight.AbstractModel' category='Method'}
 #docstring
 
 
+
 ```julia
 login(user, session)
 login(user, params::Dict{Symbol,Any})
 ```
 
+
 Persists on session the id of the user object and returns the session.
 
+
+[source](https://github.com/GenieFramework/GenieAuthentication.jl/blob/v2.2.0/src/GenieAuthentication.jl#L105-L110)
+
 ::
-::ApiCard{object="GenieAuthentication.logout-Tuple{GenieSession.Session}" category="Method"}
+::ApiCard{object='GenieAuthentication.logout-Tuple{GenieSession.Session}' category='Method'}
 #docstring
 
 
+
 ```julia
 logout(session) :: Sessions.Session
 logout(params::Dict{Symbol,Any}) :: Sessions.Session
 ```
 
+
 Deletes the id of the user object from the session, effectively logging the user off.
 
+
+[source](https://github.com/GenieFramework/GenieAuthentication.jl/blob/v2.2.0/src/GenieAuthentication.jl#L119-L124)
+
 ::
-::ApiCard{object="GenieAuthentication.with_authentication-Tuple{Function, Function, Union{Nothing, GenieSession.Session}}" category="Method"}
+::ApiCard{object='GenieAuthentication.with_authentication-Tuple{Function, Function, Union{Nothing, GenieSession.Session}}' category='Method'}
 #docstring
 
 
+
 ```julia
 with_authentication(f::Function, fallback::Function, session)
 with_authentication(f::Function, fallback::Function, params::Dict{Symbol,Any})
 ```
 
+
 Invokes `f` only if a user is currently authenticated on the session, `fallback` is invoked otherwise.
 
+
+[source](https://github.com/GenieFramework/GenieAuthentication.jl/blob/v2.2.0/src/GenieAuthentication.jl#L133-L138)
+
 ::
-::ApiCard{object="GenieAuthentication.without_authentication-Tuple{Function, GenieSession.Session}" category="Method"}
+::ApiCard{object='GenieAuthentication.without_authentication-Tuple{Function, GenieSession.Session}' category='Method'}
 #docstring
 
 
+
 ```julia
 without_authentication(f::Function, session)
 without_authentication(f::Function, params::Dict{Symbol,Any})
 ```
 
+
 Invokes `f` if there is no user authenticated on the current session.
 
+
+[source](https://github.com/GenieFramework/GenieAuthentication.jl/blob/v2.2.0/src/GenieAuthentication.jl#L151-L156)
+
 ::
-::ApiCard{object="GenieAuthentication.@authenticated!" category="Macro"}
+::ApiCard{object='GenieAuthentication.@authenticated!' category='Macro'}
 #docstring
 
 
+
 ```julia
 @authenticate!(exception::E = ExceptionalResponse(Genie.Renderer.redirect(:show_login)))
 ```
 
+
 If the current request is not authenticated it throws an ExceptionalResponse exception.
 
+
+[source](https://github.com/GenieFramework/GenieAuthentication.jl/blob/v2.2.0/src/GenieAuthentication.jl#L65-L69)
+
 ::

content/2.framework/2.genie.jl/4.Plugins/GenieAuthorisation/genieauthorisation.md

@@ -1,13 +1,18 @@
 
 
-::ApiCard{object="GenieAuthorisation.install-Tuple{String}" category="Method"}
+::ApiCard{object='GenieAuthorisation.install-Tuple{String}' category='Method'}
 #docstring
 
 
+
 ```julia
 install(dest::String; force = false, debug = false) :: Nothing
 ```
 
-Copies the plugin's files into the host Genie application.
+
+Copies the plugin's files into the host Genie application.
+
+
+[source](https://github.com/GenieFramework/GenieAuthorisation.jl/blob/v2.0.1/src/GenieAuthorisation.jl#L90-L94)
 
 ::

content/2.framework/2.genie.jl/4.Plugins/GenieCacheFileCache/_dir.yml

@@ -0,0 +1 @@
+title: GenieCacheFileCache

content/2.framework/2.genie.jl/4.Plugins/GenieCacheFileCache/geniecachefilecache.md

@@ -0,0 +1,114 @@
+
+
+::ApiCard{object='GenieCache.fromcache-Tuple{Any}' category='Method'}
+#docstring
+
+
+
+```julia
+fromcache(key::Any, expiration::Int; dir::String = "") :: Union{Nothing,Any}
+```
+
+
+Retrieves from cache the object stored under the `key` key if the `expiration` delta (in seconds) is in the future.
+
+
+[source](https://github.com/GenieFramework/GenieCacheFileCache.jl/blob/v2.0.0/src/GenieCacheFileCache.jl#L61-L65)
+
+::
+::ApiCard{object='GenieCache.purge-Tuple{Any}' category='Method'}
+#docstring
+
+
+
+```julia
+purge(key::Any) :: Nothing
+```
+
+
+Removes the cache data stored under the `key` key.
+
+
+[source](https://github.com/GenieFramework/GenieCacheFileCache.jl/blob/v2.0.0/src/GenieCacheFileCache.jl#L82-L86)
+
+::
+::ApiCard{object='GenieCache.purgeall-Tuple{}' category='Method'}
+#docstring
+
+
+
+```julia
+purgeall(; dir::String = "") :: Nothing
+```
+
+
+Removes all cached data.
+
+
+[source](https://github.com/GenieFramework/GenieCacheFileCache.jl/blob/v2.0.0/src/GenieCacheFileCache.jl#L94-L98)
+
+::
+::ApiCard{object='GenieCache.tocache-Tuple{Any, Any}' category='Method'}
+#docstring
+
+
+
+```julia
+tocache(key::Any, content::Any; dir::String = "") :: Nothing
+```
+
+
+Persists `content` onto the file system under the `key` key.
+
+
+[source](https://github.com/GenieFramework/GenieCacheFileCache.jl/blob/v2.0.0/src/GenieCacheFileCache.jl#L47-L51)
+
+::
+::ApiCard{object='GenieCacheFileCache.cache_path!-Tuple{AbstractString}' category='Method'}
+#docstring
+
+
+
+```julia
+cache_path!(cachepath::AbstractString)
+```
+
+
+Sets the default path of the cache folder.
+
+
+[source](https://github.com/GenieFramework/GenieCacheFileCache.jl/blob/v2.0.0/src/GenieCacheFileCache.jl#L20-L24)
+
+::
+::ApiCard{object='GenieCacheFileCache.cache_path-Tuple{Any}' category='Method'}
+#docstring
+
+
+
+```julia
+cache_path(key::Any; dir::String = "") :: String
+```
+
+
+Computes the path to a cache `key` based on current cache settings.
+
+
+[source](https://github.com/GenieFramework/GenieCacheFileCache.jl/blob/v2.0.0/src/GenieCacheFileCache.jl#L30-L34)
+
+::
+::ApiCard{object='GenieCacheFileCache.cache_path-Tuple{}' category='Method'}
+#docstring
+
+
+
+```julia
+cache_path()
+```
+
+
+Returns the default path of the cache folder.
+
+
+[source](https://github.com/GenieFramework/GenieCacheFileCache.jl/blob/v2.0.0/src/GenieCacheFileCache.jl#L10-L14)
+
+::

content/2.framework/2.genie.jl/4.Plugins/GenieCacheRedisCache/_dir.yml

@@ -0,0 +1 @@
+title: GenieCacheRedisCache