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.

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

74 set up a site #104

Merged
merged 3 commits into from
Feb 12, 2024
Merged

74 set up a site #104

merged 3 commits into from
Feb 12, 2024

Conversation

deemp
Copy link
Member

@deemp deemp commented Feb 8, 2024

Closes #74

Rendered: https://deemp.github.io/normalizer/


PR-Codex overview

Focus of this PR:

This PR focuses on adding documentation and improving the site layout and styling.

Detailed summary:

  • Added README.md to the site/docs directory.
  • Updated SUMMARY.md with a link to the README.md file.
  • Added a redirect page to index.html that redirects to /docs.
  • Added book.toml with book configuration.
  • Updated ghc.yml workflow to build and upload the site instead of Haddock documentation.
  • Added pagetoc.css and pagetoc.js for custom styling and functionality.
  • Updated index.hbs with custom HTML head and theme stylesheets.

The following files were skipped due to too many changes: site/docs/theme/index.hbs

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

@deemp deemp linked an issue Feb 8, 2024 that may be closed by this pull request
3 tasks
@deemp deemp requested a review from fizruk February 8, 2024 14:33
site/index.html Outdated
<meta http-equiv="refresh" content="0; url=./docs" />
</head>
<body>
Redirecting to <a href="./docs">Blog/</a>...
Copy link
Collaborator

Choose a reason for hiding this comment

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

@deemp I think this might be not actual?

Copy link
Member Author

Choose a reason for hiding this comment

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

@fizruk, see the gh-pages structure https://github.com/deemp/normalizer/tree/gh-pages. I need this index.html because I create a non-root docs directory.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Then why is it redirecting to a blog?

Copy link
Member Author

Choose a reason for hiding this comment

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

Because I copy-pasted it from rzk and didn't notice. Fixed in 94eb0ba

@deemp
Copy link
Member Author

deemp commented Feb 11, 2024

@fizruk, what files layout on the gh-pages branch should be optimal?

@fizruk fizruk merged commit b1781ea into master Feb 12, 2024
5 checks passed
@aabounegm aabounegm deleted the 74-set-up-a-site branch March 4, 2024 15:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Set up a site
2 participants