Skip to content

Setup microsite#104

Merged
joroKr21 merged 2 commits intotypelevel:mainfrom
armanbilge:microsite
Sep 17, 2022
Merged

Setup microsite#104
joroKr21 merged 2 commits intotypelevel:mainfrom
armanbilge:microsite

Conversation

@armanbilge
Copy link
Member

@armanbilge armanbilge commented Sep 17, 2022

After merging you will also need to configure your repository settings:

  1. Grant "Read and write" permissions to workflows. This enables them to push to the gh-pages branch. https://github.com/typelevel/shapeless-3/settings/actions
  2. Set the GitHub pages source to the / (root) directory on the gh-pages branch. https://github.com/typelevel/shapeless-3/settings/pages

@armanbilge
Copy link
Member Author

The microsite is already equipped with mdoc:
https://scalameta.org/mdoc/

To start a live-preview server locally run docs/tlSitePreview in sbt.

Developer("TimWSpence", "Tim Spence", "timothywspence@gmail.com", url("https://twitter.com/timwspence"))
)

lazy val docs = project.in(file("site")).enablePlugins(TypelevelSitePlugin)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why in(file("site"))?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It can be anything you want except docs/, per mdoc instructions.
https://scalameta.org/mdoc/docs/installation.html#sbt

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that the docs do still live in the docs/ folder.

Copy link
Member

@joroKr21 joroKr21 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, I will look into the settings later 👍

@joroKr21 joroKr21 merged commit 357daed into typelevel:main Sep 17, 2022
@joroKr21 joroKr21 added the documentation Improvements or additions to documentation label Sep 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants