Skip to content

Commit

Permalink
Documentation Migration (#22)
Browse files Browse the repository at this point in the history
Migration of content from Gitbook complete
  • Loading branch information
Cle4ncuts authored Nov 28, 2022
2 parents 5abffdd + 3172fa6 commit 4a492a2
Show file tree
Hide file tree
Showing 71 changed files with 2,386 additions and 41 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@ _site/
.bundle/
vendor/
.devcontainer/
:Zone.Identifier
39 changes: 25 additions & 14 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -75,42 +75,53 @@ collections_dir: docs
collections:
contribute:
permalink: "/:collection/:path/"
output: true
output: false
learn:
permalink: "/:collection/:path/"
output: true
output: false
govern:
permalink: "/:collection/:path/"
output: true
output: false
develop:
permalink: "/:collection/:path/"
output: true
test:
permalink: "/:collection/:path/"
output: true
vaults:
permalink: "/:collection/:path/"
output: false
project:
permalink: "/:collection/:path/"
output: true

essentials:
permalink: "/:collection/:path/"
output: true
community:
permalink: "/:collection/:path/"
output: true
info:
permalink: "/:collection/:path/"
output: true

just_the_docs:
# Define which collections are used in just-the-docs
collections:
contribute:
name: 🤝 Contribute
project:
name: 🤝 Project
nav_exclude: false
nav_fold: true
search_exclude: false
learn:
essentials:
# Give the collection a name
name: 📓 Learn
name: 📓 Essentials
# Exclude the collection from the navigation
nav_exclude: false
# Fold the collection in the navigation
nav_fold: true
# Exclude the collection from the search
search_exclude: false
govern:
name: 🏛️ Govern
community:
name: 🏛️ Community
nav_exclude: false
nav_fold: true
search_exclude: false
Expand All @@ -124,9 +135,9 @@ just_the_docs:
nav_exclude: false
nav_fold: true
search_exclude: false
vaults:
name: 🏦 Vaults
nav_exclude: true
info:
name: 🏛️ Info
nav_exclude: false
nav_fold: true
search_exclude: false

Expand Down
40 changes: 26 additions & 14 deletions _config_local.yml
Original file line number Diff line number Diff line change
Expand Up @@ -80,42 +80,53 @@ collections_dir: docs
collections:
contribute:
permalink: "/:collection/:path/"
output: true
output: false
learn:
permalink: "/:collection/:path/"
output: true
output: false
govern:
permalink: "/:collection/:path/"
output: true
output: false
develop:
permalink: "/:collection/:path/"
output: true
test:
permalink: "/:collection/:path/"
output: true
vaults:
permalink: "/:collection/:path/"
output: false
project:
permalink: "/:collection/:path/"
output: true

essentials:
permalink: "/:collection/:path/"
output: true
community:
permalink: "/:collection/:path/"
output: true
info:
permalink: "/:collection/:path/"
output: true

just_the_docs:
# Define which collections are used in just-the-docs
collections:
contribute:
name: 🤝 Contribute
project:
name: 🤝 Project
nav_exclude: false
nav_fold: true
search_exclude: false
learn:
essentials:
# Give the collection a name
name: 📓 Learn
name: 📓 Essentials
# Exclude the collection from the navigation
nav_exclude: false
# Fold the collection in the navigation
nav_fold: true
# Exclude the collection from the search
search_exclude: false
govern:
name: 🏛️ Govern
community:
name: 🏛️ Community
nav_exclude: false
nav_fold: true
search_exclude: false
Expand All @@ -129,12 +140,13 @@ just_the_docs:
nav_exclude: false
nav_fold: true
search_exclude: false
vaults:
name: 🏦 Vaults
nav_exclude: true
info:
name: 🏛️ Info
nav_exclude: false
nav_fold: true
search_exclude: false


plugins:
- jekyll-default-layout
- jekyll-feed
135 changes: 135 additions & 0 deletions _drafts/_config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,135 @@
title: "Y-Foundry Docs"
description: Mutably Good Documentation
logo: "/assets/images/horizontal_logo_orange-white.png"

email: [email protected]
twitter_username: YFoundryDAO
github_username: yfoundry

remote_theme: just-the-docs/[email protected]
color_scheme: yfd
callouts_level: loud # or quiet
callouts:
highlight:
title: 🌈 Highlight
color: yellow
important:
title: ⚡ Important
color: blue
new:
title: ✨ New ✨
color: pink
note:
title: 📝 Note
color: purple
warning:
title: ⚠️ Warning
color: red
gov:
title: 🗳️ Governance
color: green

# Aux links for the upper right navigation
aux_links:
"Medium":
- "//medium.com/@yfoundry/"
"Discord":
- "//discord.gg/yfd"
"Twitter":
- "//twitter.com/YFoundryDAO"
"Telegram":
- "//t.me/yfoundrydao"
"Github":
- "//github.com/Y-Foundry-DAO/"
"Website":
- "//yfoundry.io/"

aux_links_new_tab: true



# Footer content
# appears at the bottom of every page's main content

# Back to top link
#back_to_top: true
#back_to_top_text: "Back to top"

footer_content: ""

# Footer last edited timestamp
last_edit_timestamp: true # show or hide edit time - page must have `last_modified_date` defined in the frontmatter
#last_edit_time_format: "%b %e %Y at %I:%M %p" # uses ruby's time format: https://ruby-doc.org/stdlib-2.7.0/libdoc/time/rdoc/Time.html
last_edit_time_format: "%b %e %Y" # uses ruby's time format: https://ruby-doc.org/stdlib-2.7.0/libdoc/time/rdoc/Time.html

# Footer "Edit this page on GitHub" link text
gh_edit_link: true # show or hide edit this page link
gh_edit_link_text: "Edit in Github"
gh_edit_repository: "https://github.com/Y-Foundry-DAO/yfd-docs" # the github URL for your repo
gh_edit_branch: "main" # the branch that your docs is served from
# gh_edit_source: docs # the source that your files originate from
gh_edit_view_mode: "edit" # "tree" or "edit" if you want the user to jump into the editor immediately

# Define Jekyll collections
collections_dir: docs
collections:
contribute:
permalink: "/:collection/:path/"
output: true
learn:
permalink: "/:collection/:path/"
output: true
govern:
permalink: "/:collection/:path/"
output: true
develop:
permalink: "/:collection/:path/"
output: true
test:
permalink: "/:collection/:path/"
output: true
vaults:
permalink: "/:collection/:path/"
output: true

just_the_docs:
# Define which collections are used in just-the-docs
collections:
contribute:
name: 🤝 Contribute
nav_exclude: false
nav_fold: true
search_exclude: false
learn:
# Give the collection a name
name: 📓 Learn
# Exclude the collection from the navigation
nav_exclude: false
# Fold the collection in the navigation
nav_fold: true
# Exclude the collection from the search
search_exclude: false
govern:
name: 🏛️ Govern
nav_exclude: false
nav_fold: true
search_exclude: false
develop:
name: 💻 Develop
nav_exclude: false
nav_fold: true
search_exclude: false
test:
name: 🧪 Test
nav_exclude: false
nav_fold: true
search_exclude: false
vaults:
name: 🏦 Vaults
nav_exclude: true
nav_fold: true
search_exclude: false

plugins:
- jekyll-default-layout
- jekyll-feed
Loading

0 comments on commit 4a492a2

Please sign in to comment.