dillonkearns/elm-pages-v3-beta
1
1
Fork 0
mirror of https://github.com/dillonkearns/elm-pages-v3-beta.git synced 2025-01-08 07:29:08 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update docs.

Browse Source
This commit is contained in:
Dillon Kearns 2019-09-15 15:44:48 -07:00
parent 3070f58373
commit 08050be439
1 changed files with 24 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
elm-package/src/Head.elm
View File

@ -1,4 +1,18 @@
module Head exposing (AttributeValue, Tag, canonicalLink, currentPageFullUrl, description, fullImageUrl, fullPageUrl, metaName, metaProperty, raw, toJson)
module Head exposing
( Tag, AttributeValue, currentPageFullUrl, description, fullImageUrl, fullPageUrl, metaName, metaProperty, raw
, toJson, canonicalLink
)
{-|
@docs Tag, AttributeValue, currentPageFullUrl, description, fullImageUrl, fullPageUrl, metaName, metaProperty, raw
## Functions for use by generated code
@docs toJson, canonicalLink
-}
import Json.Encode
import Pages.ImagePath as ImagePath exposing (ImagePath)
@ -41,7 +55,10 @@ type AttributeValue pathKey
| FullUrlToCurrentPage
{-| Example:
{-| It's recommended that you use the `Seo` module helpers, which will provide this
for you, rather than directly using this.
Example:
Head.canonicalLink "https://elm-pages.com"
@ -96,6 +113,8 @@ metaName name content =
]
{-| Low-level function for creating a tag for the HTML document's `<head>`.
-}
node : String -> List ( String, AttributeValue pathKey ) -> Tag pathKey
node name attributes =
Tag
@ -104,6 +123,9 @@ node name attributes =
}
{-| Feel free to use this, but in 99% of cases you won't need it. The generated
code will run this for you to generate your `manifest.json` file automatically!
-}
toJson : String -> String -> Tag pathKey -> Json.Encode.Value
toJson canonicalSiteUrl currentPagePath (Tag tag) =
Json.Encode.object