Giter Club home page Giter Club logo

wedocs's Introduction

weDocs

WordPress documentation theme to use with weDocs plugin.

demo: docs.wedevs.com

screenshot

Power Installation

  1. If you know how to git, then clone the repo: git clone https://github.com/tareq1988/wedocs.git to your themes directory.

  2. Log in to your dashboard and navigate to Appearance → Themes. Click the Activate button on the weDocs theme.

##Simple Installation

  1. Download the .zip file from here*.

  2. Navigate to wp-admin → Appearance → Themes → Add New → Upload Theme. Choose the zip file you just downloaded, upload and activate.

If you do not have weDocs plugin installed, go to Plugins → Add New and Search for wedocs and install.

##Customize

The theme only has a feature to use a custom image as a logo. Navigate to Appearance → Customizer. Then you will find the option to add a custom logo image.

If you want to add more features, please fork and help 🙂.

Of course, you can customize the style and the source code as you like. Pull requests are always exciting!

Built with

Contribute

If you want to contribute to this project and have any questions, open an issue or send a mail to support at wedevs dot com.

Author

Tareq Hasan

wedocs's People

Contributors

hamedmoody avatar tareq1988 avatar techjewel avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

wedocs's Issues

Posts with private status get lost

If anyone does not want front-end users to see any post and just set the status to 'private', it gets disappeared.
Even admin can't see private posts under weDocs.

Theme Color Changes

Any easy way to update some of the main theme colors, like the green? I see it looks like everything is buried in the main.min.css :/

Child theming: get_template_directory_uri() vs get_stylesheet_directory_uri()

I wanted to make a child theme but noticed all stylesheets are exclusively loaded from the main theme by the use of get_template_directory_uri. Is there any specific reason why you don't want to allow overrides of the stylesheets? Using get_stylesheet_directory_uri() instead would solve this and I cannot see any downsides to it... In this aspect it would also help to enqueue the main style.css (with get_stylesheet_directory_uri()): even though you don't use it, it's very convenient for simple overrides and it would follow general wordpress conventions.

I understand that I could just load my own styles on top of yours, but performance wise, overrides can be a better option. Interested to hear your thoughts!

Homepage

I don't understand how can i make my homepage like in your demo. Currently my homepage shows posts categories. Can you help?

Use a consistent branching model

Thank you for the great theme. I am enjoying creating a documentation website with it!

I noticed that the Develop and Master branches don't really make sense right now (Network Graph).

Specifically, the Develop branch is missing a few commits from Master (one of those commits is actually duplicated in both branches, at different times, and different authors).

I propose adopting the popular branching model: Gitflow; I also think using verioning will help advance the project.

To do this, we should:

  1. Merge Master into Develop
  2. Merge contributions via pull request only to Develop
  3. When ready, merge Develop into Master and bump the version number.

The reason why I made this issue is that I am not really sure what branch is more complete....they both seem to have small differences that should be included in both branches.

Take a look at my Develop fork with the current Master merged in.

Any thoughts?

Do not bake bootstrap CSS

Pretty nice theme but you unfortunately made some bad choices technically.

I tried to update bootstrap CSS and it is not possible since you baked your own CSS with bootstraps CSS in main.min.css

You should have bootstrap.min.css in it's own file. And your own custom CSS be included on the page like wedocs.min.css to overwrite the parts you want to style.

Right now this is impossible

Removing votes

Hi, is there a way to remove the voting icons?
icons Thanks a lot!

Doc Tags not working

Minor presentational issue is that the theme templates don't output the tags, while switching to a different theme (e.g. 2017) so that the plugin templates are used does output the tags.

More importantly, the tag archive doesn't work in the theme. Going to site.com/doc-tag/slug works on 2017 but with weDocs theme gives "Nothing found!" message.

In the back-end at weDocs>Tags the doc-tags are listed. Clicking the number in the counts column takes you to a list of zero posts. The link is missing the post type url parameter (post_type=docs).

How to get title and excertp from article in section

Hello, sorry for my english.
I've a question.
If I navigate to section page in frontend the theme see me my text and link about all article in this section.
I would like to expand this link adding exerpt from article (or text within read more button) for better use, as in search result.
It is possible?
Where I can modify div "article-child well" element?
Thansk a lot.
Lorenzo

Switch to 'Classic UI' option from the footer is missing

Hello there,

I am using the weDocs v1.6.2 in WordPress v5.5.3 using Docly v1.1.1 theme.

Not sure what happened, but I am missing the switch to the "Classic UI" option from the footer/bottom part of the page in the weDocs plugin. I have many docs (70+) and need to change the hierarchy of them and got stuck due to the unavailability of that "Classic UI" option. Fyi - I could able to see that option around 3-4 weeks back and now it's surprisingly missing. Please see the screenshot and kindly do the needful.

Regards,
Gautham P
Screen Shot 2020-10-31 at 10 44 36 PM

Add post navigation

If I am writing a step by step guide for the customers to install and configure a software, then using a next and previous post navigation will be really helpful for them.

weDocs doesn't show all the child categories when using Gutenberg

Hello,

After writing a post using Gutenberg Editor, when we try to choose the category in Parent Doc, most of the child categories are missing. This is an issue that I was able to reproduce on a couple of websites and on local environment too.

It would be good if this can be fixed.

Thanks!

Homepage - only first level categories showing

Very functional documentation theme, however only the first level of category is showing in the home page, whereas on the demo page one can see sub-category levels as well.

Any help appreciated.
Thanks

Mobile Menu does not work

On the front end, when your browser width is small enough to trigger the mobile menu button, clicking on it does nothing.
untitled

Side note: Overall awesome job on this theme and plugin!

How can I show Docs instead of categories in homepage?

Thanks Tareq for your work.

I'm moving my documentation and project management site from MediaWiki to WordPress, and I'd like to use your weDocs theme. My homepage right now in the wiki looks a lot like your demo -> http://docs.wedevs.com/

But when I installed the theme, the homepage in my WordPress site showed post categories instead of docs. How can I remove categories and display docs nstead?

Thank you in advance.

featured image

I am attempting to get the featured image set on each category title post to display on the wedocs main catagory page. e.g.

https://help.tibus.net - an image beside/above "Email" category section title.

The wedocs theme does have:
lib/init.php: add_theme_support('post-thumbnails');

I cannot find the correct location in the theme to include the thumbnail:

// check if the post or page has a Featured Image assigned to it.
if ( has_post_thumbnail() ) {
    the_post_thumbnail();
}

I do see you setting images on your theme demo site https://wedevs.com/docs specifically the "Others" section on the demo site is close to how I would like it.

Could you direct me to the correct place to make the edit in the theme?

Thanks,

Child Categories

Hi, how do I get child categories to show on main page like your demo has?

Thanks

Aled

TOC Sidebar

After upgrading to WP 4.0, the generated table of contents sidebar shows each item twice when a user is logged in.

Demo misrepresents functionality

I really appreciate the effort you've taken in creating this theme and sharing it, however the demo site is misleading. I cannot replicate it using the theme and the documentation provided in the readme. Specifically, the sidebar navigation is vastly different from the demo. In the theme, h1 tags in a specific post have menu items in the sidenav, but there are no sidenav menu items for specific posts within categories as in the demo.

I would suggest you set up a representative demo site or update the documentation (readme) to explain how this functionality can be achieved.

The benefit of this amazing theme you have created is that developers can quickly and easily set up accessible documentation with good navigation. Unfortunately because the demo is different from the actual theme, you end up costing people time who are misled. While I appreciate that a developer can easily branch off and fix things up, this undermines the "quick and easy" part and essentially this theme is no longer suitable for many people who would like to plug and play and replicate the demo without hassle.

As others have mentioned, people would gladly pay for a premium version if it works as demonstrated, but currently it seems to be costing a few people time they could have saved buying a premium theme. Thanks again.

No CSS with Wordpress 5.3.2

Hello,

Since i have updated my Wordpress to last version ( 5.3.2 ) it looks the CSS of wedocs isn't loaded :
image

I'm using the last plugins version.

Apply "current_page_item" to all sections

Hi,
Great theme...really awesome for what I am doing. I'd like to have all the sidebar parent items open by default, but I am not having any luck with it. I have tried to do

   $output .= '<li class="' . implode( ' ', $classes ) . ' current_page_parent"><a href="' . get_permalink( self::$parent_item ) . '">' . __( 'Introduction', 'wedocs' ) . '</a></li>';
...

but it did not work. Any idea?

Change editor layout from wedocs theme

I need to know if exists a plug in that modifies the visual editor from wedocs theme. Because i need a layout more accessible for the editors from my blog work.

Thanks.

Installed theme doesnt look like the demo

The notes state there are no options and i cant find any in the theme to double check. It looks like the main page of the theme is based off post categories rather than anything to do with the docs. How do i get it to look like the demo site?

Change the "/docs/" in the url to be "<whatever-I-want>".

I know this has been asked back in 2017 and the issue was closed, but it doesn't make sense now with the new version of WeDocs 1.6.2.
I currently have this development site: https://devkompar.wpengine.com/docs/why-use-static-analysis/ and I'd like to change the "/docs/" in the url to be "".

Do I need to add this "rewrite" code to the file of wedocs.php

$rewrite = array( 'slug' => 'docs', 'with_front' => false, 'pages' => true, 'feeds' => true,
If so where?

Or is there another certain file I can go into to change it?

Originally posted by @rosangelamAVI in #46 (comment)

Theme not showing in dashboard

Running wordpress 4.4 and I moved wedocs-master into the themes folder. The theme will not show up as an option though.

Missing textdomain causes untranslated strings

Hello,

Can you add 'wedocs' string as third argument of esc_attr_x() function in includes/class-search-widget.php, lines 46, 46 again, and 52.

Because for an unknown reason the input placeholder 'Documentation Search …' isn't translated (in French in my case) without the textdomain.

Thanks,

possibility for translation

Hi,

I was wondering if it's possible to get a pot file to translate it, i could send it in dutch if you like.
I tried to generate a .po file but i seem to get no results bij translating it and placing it in the languages/themes folder.

With kind regards,
Gouz91

How to add h2 submenus to dynamic navigation.

Hello,
I'm attempting to sort through the code to see where the dynamic sidebars are generated so that I can work towards an option for submenus for lesser headings and a true TOC kind of layout.

Any pointers or directions?

Wrong breadcrumbs for posts without parents.

Hello,
The breadcrumbs of posts without parents always get "Docs" in breadcrumbs, and actually there is no page is called "Docs" at all (so it's returns 404).

How it does look like:
old_single_page_wedocs_theme_small

How it should be:
new_single_page_wedocs_theme_small

I believe this related to that part in "lib/custom.php" (and yeah, I'm using "develop" branch):

echo '<a href="' . $homeLink . '/' . $slug['slug'] . '/">' . $post_type->labels->singular_name . '</a>';
if ($showCurrent == 1) echo ' ' . $delimiter . ' ' . $before . get_the_title() . $after;

And should be replaced with:

if ($showCurrent == 1) echo ' ' . $before . get_the_title() . $after;

If I get it right and this is not intended, I will make a PR.
Thanks a lot.

docs category

Hi,
Is there a way add category to docs i couldn't see so far.
image

Main Page Article Navigation

Hi I see on your demo you have a main article page with navigation built in. Is this automated through the theme somehow, or do you have to add a link manually to the main page every time you add a child article?

For example at:
http://docs.wedevs.com/

Under "Dokan" you have links

  • Getting Started
  • Sellers Guide

How to show headings from WeDocs plugin, not categories

I'm using this in conjunction with the weDocs plugin available in the WP plugin repo, but this theme's homepage is only showing the headings for normal post categories, not the weDocs documentation headings like on https://docs.wedevs.com/.

Does anyone know if this is possible? Or is what the author is using on their own site not publicly available?

Thanks in advancec

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.