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

Symlink on built website to support /docs/ links #80

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

cason
Copy link

@cason cason commented Sep 29, 2023

Possibly partially addressed #79.

Introduces a symbolic link making docs/ prefixed links to be accepted by the website. For example, https://docs.cometbft.com/v0.38/docs/core/configuration.html could be accepted and render the same content as the proper link: https://docs.cometbft.com/v0.38/core/configuration.html

@@ -4,7 +4,7 @@ name: Build and Deploy to Netlify
on:
push:
branches:
- main
- cason/docs-symlink
Copy link
Author

Choose a reason for hiding this comment

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

This MUST be reverted when merging.

@cason
Copy link
Author

cason commented Sep 29, 2023

A previous attempt was performing adding the symbolic links as part of the make fetch command.

However, at the make build step jekyll ignores the symbolic links.

@cason
Copy link
Author

cason commented Sep 29, 2023

The workflow does not use make build, invoking jekyll directly.

A possibility is to introduce a new make symlinks command to be executed after the building.

@cason
Copy link
Author

cason commented Sep 29, 2023

While this procedure indeed produces the symlinks under _pages/, the updated website does not work as expected.

Either because the symlinks are not uploaded (properly), or because the web site configuration disables this behavior.

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.

1 participant