Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updated packages #2

Merged
merged 1 commit into from
Sep 20, 2023
Merged

updated packages #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion FASTN.ftd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,12 @@

-- fastn.package: <user_name>.github.io/<repo_name>

-- fastn.dependency: fifthtry.github.io/package-doc
-- fastn.dependency: fastn-community.github.io/site-doc
-- fastn.dependency: fastn-community.github.io/code-block
-- fastn.dependency: fastn-community.github.io/footer

-- fastn.auto-import: fastn-community.github.io/site-doc
-- fastn.auto-import: fastn-community.github.io/code-block as cb



Expand Down
51 changes: 21 additions & 30 deletions custom.ftd
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
-- import: <user_name>.github.io/<repo_name>/assets as <repo_name>-assets
-- import: fifthtry.github.io/package-doc/doc as pd
-- import: fifthtry.github.io/package-doc/forest-theme as ds
-- import: fifthtry.github.io/package-doc/footer

;; ⚠️fastn-builders::⚠️ before using this file please find and replace <font-name>
;; with font name you have given inside
Expand All @@ -12,46 +9,36 @@



-- ds.page:
show-footer: true
site-name: `<repo_name>`

-- ds.page.footer:

-- footer.fastn-footer:

-- end: ds.page.footer

-- pd.package: FTD <repo_name> package
name: <user_name>.github.io/<repo_name>
-- site-doc.doc-home: FTD <repo_name> package
site-title: `<repo_name>`
show-tabs: false
github-url: <user_name>.github.io/<repo_name>
current-package: <user_name>.github.io/<repo_name>

This FTD font `<repo_name>` package is for your ftd web projects. To Use this
<repo_name> inside `FTD` project follow below instructions.

-- ds.h3: How to use <repo_name>?
-- site-doc.header: How to use <repo_name>?

-- ds.code: Add this to your FASTN.ftd
-- cb.code: Add this to your FASTN.ftd
lang: ftd

\-- fastn.dependency: <user_name>.github.io/<repo_name>

-- ds.markdown:
-- site-doc.header: Next step:

After adding <repo_name> dependency inside your `FASTN.ftd` file, You need to
add <repo_name> assets and import it inside your `.ftd` files where you are
using this font for your custom font types.

To include <repo_name> into your `ftd` file follow below instructions.

-- ds.code:
-- cb.code:
lang: ftd

\-- import: <user_name>.github.io/<repo_name>/assets as <repo_name>-assets


-- ds.h3: How to create a custom <repo_name> type?

-- ds.markdown:
-- site-doc.header: How to create a custom <repo_name> type?

We don't recommend creating custom types. We recommend to use
our [<repo_name>-typography](https://<user_name>.github.io/<repo_name>-typography)
Expand All @@ -65,16 +52,15 @@ We hope you shouldn't need to define a custom type.

Below is an example of creating a custom `ftd.type` using <repo_name>.

-- ds.rendered:
/-- cb.rendered: Demo:

-- ds.rendered.input:
-- cb.rendered.input:

\-- ftd.type <repo_name>-size-12-desktop:
size.px: 12
weight: 400
font-family: $<repo_name>-assets.fonts.<font-name>


\-- ftd.type <repo_name>-size-12-mobile:
size.px: 12
weight: 400
Expand All @@ -92,7 +78,10 @@ color: $inherited.colors.text-strong

👉 The quick brown fox jumps over the lazy dog

-- ds.rendered.output:
-- cb.rendered.output:

-- site-doc.output:
colors: $ftd.default-colors

-- ftd.text:
role: $<repo_name>-size-12-400
Expand All @@ -102,11 +91,13 @@ color: $inherited.colors.text-strong

👉 The quick brown fox jumps over the lazy dog

-- end: ds.rendered.output
-- end: site-doc.output

-- end: cb.rendered.output

-- end: ds.rendered
-- end: cb.rendered

-- end: ds.page
-- end: site-doc.doc-home



Expand Down
34 changes: 7 additions & 27 deletions index.ftd
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,29 +1,20 @@
-- import: fifthtry.github.io/package-doc/doc as pd
-- import: fifthtry.github.io/package-doc/forest-theme as ds
-- import: <user_name>.github.io/<repo_name>/custom
-- import: fifthtry.github.io/package-doc/footer




-- ds.page:
show-footer: true
site-name: `<repo_name>`

-- ds.page.footer:

-- footer.fastn-footer:

-- end: ds.page.footer

-- pd.package: <repo_name> package
name: <user_name>.github.io/<repo_name>
-- site-doc.doc-home: <repo_name> package
site-title: `<repo_name>`
show-tabs: false
github-url: <user_name>.github.io/<repo_name>
current-package: <user_name>.github.io/<repo_name>

This FTD font `<repo_name>` can be used for your ftd web projects.

To Use this <repo_name> inside `FTD` project visit [<repo_name>-typography](https://<user_name>.github.io/<repo_name>-typography).

-- ds.h3: <repo_name> various sizes
-- site-doc.header: <repo_name> various sizes

-- ftd.text:
role: $custom.<repo_name>-size-12-400
Expand All @@ -33,7 +24,6 @@ color: $inherited.colors.text-strong

👉 The quick brown fox jumps over the lazy dog


-- ftd.text:
role: $custom.<repo_name>-size-12-800
color: $inherited.colors.text-strong
Expand All @@ -50,7 +40,6 @@ color: $inherited.colors.text-strong

👉 The quick brown fox jumps over the lazy dog


-- ftd.text:
role: $custom.<repo_name>-size-18-400
color: $inherited.colors.text-strong
Expand Down Expand Up @@ -99,13 +88,4 @@ color: $inherited.colors.text-strong

👉 The quick brown fox jumps over the lazy dog

-- end: ds.page









-- end: site-doc.doc-home