search

dennisdoomen / CSharpGuidelines

A set of coding guidelines for C# 9.0, design principles and layout rules for improving the overall quality of your code development.
https://www.csharpcodingguidelines.com
Other
746 stars 271 forks source link

Extract rules into separate Markdown files #196

Closed julianbartel closed 4 years ago

julianbartel commented 4 years ago

Extract rules into separate Markdown files to support individual Frontmatter per rule.

julianbartel commented 4 years ago

Marked as draft because I would like to clarify a few things (see file comments). One general point: I thought about removing the AV prefix in rule identifiers, so it could be tailored in forks without need to change every file.

dennisdoomen commented 4 years ago

I thought about removing the AV prefix in rule identifiers, so it could be tailored in forks without need to change every file.

I've used that prefix for the last 15 years, so I'd like to keep it. But maybe we make it a variable?

julianbartel commented 4 years ago

I've used that prefix for the last 15 years, so I'd like to keep it. But maybe we make it a variable?

That's how I meant it. ;-) I would have done it by simply remove the prefix from the IDs and put it into the template. But a variable is more precise. Just need some time to work that out as Jekyll is new to me.

dennisdoomen commented 4 years ago

Just need some time to work that out as Jekyll is new to me.

I think you can put that variable, e.g. rulePrefix, in the _config.yml and then access it through {{ site.rulePrefix }}.

julianbartel commented 4 years ago

Search is no longer working

Added rules to the search data store.

The recent look-and-feel changes somehow are not available in your PR.

Rebased PR on master. Hope this did not mess up the PR or review state, but seems to work.

dennisdoomen commented 4 years ago

Wow. This really starts to look great. I found another bug though. I'm not sure it's my local environment, bit if you search for av12, you can't open any of the results.

julianbartel commented 4 years ago

Wow. This really starts to look great. I found another bug though. I'm not sure it's my local environment, bit if you search for av12, you can't open any of the results.

Can you specify this a bit? I made a clean checkout and rebuild to check it out, but search seems to work as expected in my workspace (see screen cap). 🤔

search-sample

dennisdoomen commented 4 years ago

@julianbartel awesome work man. It does work as expected. It must have been my machine.

dennisdoomen commented 2 years ago

Hmm, just discovered that the "Edit page" button at the top of each page no longer works.