samuelhorn / jamdocs Goto Github PK

This is a feature request.

The sidebar is processing all my h2-h6 headings in my markdown as subtopics in the sidebar. Would be nice to be able to tell jamdocs that i only want to process h2-h3 or i dont want to process h6 or h5. This will give me more flexibility to control what gets added to the sidebar because some of our docs use a lot of headers.

Would be very cool if this can be a global and/or per document setting.

Thanks!

FYI, your template is great! thanks for all the work putting it together.

In the documentation, I think it says the sidebar will build links/refs to all h2 (or ## in MD); however, it is building links to all h2-h6 items in my MD file. Not sure if that might be the underlying issue.

The little green dot correctly highlights the active subtopic in the MD when it is an h2; however, it doesn't correctly highlight the the right subtopic when it is an h3 or h4... assuming same for h5.h6... when that topic is the last one... it highlights the one above.

So if I have 4 h3 headings called A,B,C,D. If I click on A, B, or C... the little green dot works correctly...however, if I click on D, then the little green dot is on C.

5. I have to manually update Menu Links (https://forestry.io/docs/editing/menus/) - Update Index.vue file (https://github.com/thedigitalkern/jamdocs/src/pages/Index.vue) in GitHub each time as sidebar does not auto fetch the links added in forestry.io starter template. Any solution around this?

6. Will the custom domain replace the Default Domain in the sitemap generated? How can I configure sitemap options - Previous step of Adding the below code to netlify.toml file is done - https://github.com/thedigitalkern/jamdocs/netlify.toml as seen here -

[[plugins]] package = "@netlify/plugin-sitemap"

But how to configure sitemap.xml URL list from "https://jamdocs.netlify.com/advertising-online-seo/" currently visible on "https://optimistic-darwin-d71561.netlify.com/sitemap.xml" with custom domain which I haven't added as of yet. For example, the sitemap should reflect like so

<url><loc>https://thedigitalkern/advertising-online-seo/</loc></url>
<url><loc>https://thedigitalkern/image-optimisation-softwares/</loc></url>

It asks me to add the following code via https://app.netlify.com/teams/(your_netlify_username)/plugins but I am not sure what file do I need to add the code in - the exact file path https://github.com/thedigitalkern/jamdocs/(file_path)?

Configuration
Configure the plugin buildDir.
Default is the publish directory from your site build settings.

[[plugins]] package = "@netlify/plugin-sitemap"
[plugins.inputs] buildDir = "public"

7. Any simple method to add/enable post search field with tag or category filters in the center-aligned menu without much of manual coding from Algolia free plan (if any) or alternative. Add "Search Icon on all pages" and "visible on the sidebar"? An example can be seen here https://weskyprint.com/portfolio.html - text tabs with posts filtered according to the category defined in the menu

8. How to Add footer with Privacy Policy, Terms of Service, Disclaimer, Security Policy along with social links on every page with copyright message at the end of each page. What file path/s needs to be edited?

9. Lastly, how to add Customised 404 page with a return to home link?

Note: Please attach the full path of the file in case you prefer to edit in GitHub repository or complete steps in Forestry.io Also can you update the ReadMe.md file?

Note to Viewers: For friends who are facing same problems - Kindly Use the direct links to add or modify the code with code structure correctly defined. Might face compile errors due to incorrect formatting.

Hello,

I am looking to use jamdocs. For my usecase, the Algolia search would be needed in the long run.
When do you plan to start this feature? Is there anything I can do to give a hand.
Great work on jamdocs! Thank you :)

Link that could be useful: https://www.stackbit.com/blog/gatsby-search/ (Algolia with Gatsby though)

Cheers,

This is a feature request.

Would be cool if the sidebar had the ability to display/hide the subtopics of non active topics. This would help to reduce the size of the side bar and make finding the topics a little easier. And then when in a topic, then display the active subtopics.

I did this in one of my deploys by adding the following to Sidebar.vue. It works, but probably would need to add a nice collapse transition to it and maybe an option to enable/disable it because others might not want this

(if i can add those I will send a PR... but here is what I have now)

Hello.

It doesn't seem possible to resolve routes with slashes in slugs.

Is this possible?

I have compiled a site using import starter template jamdocs from Netlify Hugo Forestry.io. I have a few questions regarding the same.

How can I change H1 and logo from Jamdocs to The Digital Kern on homepage
Remove "fork on github" button
Remove PayPal link pixelcroock
I have to manually update Index.vue file in github each time as sidebar does not auto fetch the links in forestry.io
Will the custom domain replace the Default Domain in the sitemap generated. How can I configure sitemap options - previous step of adding to .toml file is done. But how to configure sitemap.xml url list from https://jamdocs.netlify.com/advertising-online-seo/ curently visible on https://optimistic-darwin-d71561.netlify.com/sitemap.xml with custom domain which I haven't added as of yet.
Any simple method to add search field without much of manual coding from algolia free plan (if any) or alternative.
Add footer with Privacy Policy, Terms of Service, Disclaimer, Security Policy along with social links on every page with copyright message.
Tags Categories don't show up. Any advice?

Configuration
Configure the plugin buildDir. Default is the publish directory from your site build settings.

[[plugins]] package = "@netlify/plugin-sitemap" [plugins.inputs] buildDir = "public"
Cant seem to locate buildDir publish directory in the github repo.

Can't seem to change Icons from VueFeather Icons after adding the icon name in the github settings file
Also center align Topic Name instead of Left Aligned on Homepage.
Customised 404 page with a return to home link?

i've been getting the same as the above for docs i'm creating. i've tried setting the description in a few different places but haven't figured it out yet. the above happens in any previews (e.g. slack, discord, etc)

side note: awesome project. really love jamdocs! thank you.

Is it possible to change the default theme from light to dark?

I have a markdown file like:

---
title: HTTP Request
date: 2020-10-07 19:00:00
slug: core
---

## 404
Send an HTTP 404 response back to the client.

This throws the following error in the console:

Failed to execute 'querySelector' on 'Document': '#404' is not a valid selector.

On mobile devices, the navbar noes not behave correctly:

The page body should not be visible, and the close button should be located on the sidebar.

Would be great if the docs could be exported as a PDF (or icml file for use in InDesign)

Would be great if one could edit the front page for Jamdocs on Forestry as well, just like you edit the menu and doc-pages.

Any ideas @DirtyF? 🤔

Might be a silly question but is there any way to have the dark theme as the default?

What's the best way to set it up so that the home page lands you directly on the documents page instead of what is currently set as the index?

I have compiled a site using import starter template jamdocs from Netlify Gridsome Forestry.io.

1. How can I change H1 from "Jamdocs" to "The Digital Kern" on the homepage and from the sidebar?

2. Remove "Fork me on GitHub" button on the homepage and sidebar? Is this possible by deleting https://github.com/thedigitalkern/jamdocs/src/components/GitLink.vue file completely?

3. Can't seem to change Icons from VueFeather Icons (https://vue-feather-icons.netlify.com/) after adding the icon name in the github settings file. Is this possible by changing the following file - https://github.com/thedigitalkern/jamdocs/src/components/Shortcut.vue - You will notice that I have first added ImageIcon and LayersIcon on Line 13 and also added the same on Line 20 and 21. Then added https://github.com/thedigitalkern/jamdocs/src/pages/Index.vue on Line 10 and Line 11 - <Shortcut link="/software-gear-camera" text="Software and Gear Required" icon="image-icon" /> and <Shortcut link="/image-optimisation-softwares" text="Image Optimisation Softwares" icon="layers-icon" />

• Where do I insert this code in https://github.com/thedigitalkern/jamdocs/(file_path) ? The simple name of the attribute like "image-icon" will not work? Also do I need to attribute on each use on each page? Below code copied from https://vue-feather-icons.netlify.com/
  <template><image-icon size="1.5x" class="custom-class"></image-icon></template>
<script>import { ImageIcon } from 'vue-feather-icons' export default { components: { ImageIcon}} </script>

• If we use your recommended Feather Icon - Where to add this section of code?
  import { MoonIcon, SunIcon } from 'vue-feather-icons' export default {components: {MoonIcon,SunIcon}

• How to make the icon visible on homepage and - I mean do I just change the icon attibute name to MoonIcon or moon-icon?

4. Also center align Topic Name instead of Left Aligned on Homepage - You can notice the text is left-aligned by default - https://optimistic-darwin-d71561.netlify.com/ - How to center align the same?

Attaching the set of QUESTIONS under Sub-Topic - Homepage "Menu Links" (via Update Index.vue file) / Will "Custom Domain replace the Default Domain in the Sitemap" via "Netlify Plugins" Page / Simple "Method to Add/Enable "Page Search" field with "tag or category filters" in the "center aligned menu" show in the "menu and sidebar"" / Add "Footer with Multiple Website Policies" with "Social Links" - Import Starter Template jamdocs from Netlify Gridsome Forestry.io

Note: Please attach the full path of the file in case you prefer to edit in GitHub repository or complete steps in Forestry.io Also can you update the ReadMe.md file - https://github.com/samuelhorn/jamdocs/README.md?

Note to Viewers: For friends who are facing the same problems - Kindly Use the direct links to add or modify the code with code structure correctly defined. Might face compile errors due to incorrect formatting.

The sidebar will become too long if there're many articles. Is it better if the content table is shown only when the article is the active one?

Trying to run the start results in errors due to packages being outdated. This is fixed with a yarn upgrade. Pull request to follow.