I am Waseem Ahmed. I really liked your documentation page (https://aframe.io/docs/1.3.0/introduction/#getting-started). Specifically the way all the documents arranged in the left hand side panel and ability to select any topic and move to the next document from footer link. Would you please let me know which documentation portal you are using for your documents? I would like to create similar documentation for my website. Thank you.
There's a github repo for their website. It's mentioned that they built the website using the Hexo framework.
This site is built using hexo. Site content is written in Markdown (and located in the src/ directory). Pull requests are welcome!
Although, you don't necessarily need to use Hexo. There are plenty of static site generators (SSGs) you can use to generate your documentation.
Related
I would like to query a website that provides files for download to see all the available files for download.
For example: webpage called https://download.website.com/path/to/file has a file of interest to me, but I would also like to see other available files available in the system publicly.
Essentially I would like to be able to view a hierarchy of all of the publicly-facing files given some parent link. So if I know I want all files stored under https://download.website.com/path/, the query would turn up a recursive list of available files from https://download.website.com/path/*.
Is this even possible to do for most websites? Would allowing this behavior be too compromising to web frameworks in general, so it might not exist? Am I XYing out of control?
Any help here greatly appreciated.
This method isn't perfect, but you can try it. Just put this query in Google Search.
You can do a Google search for some publicly available and indexed path.
For example if you want to search all available page on a website/domain:
site:download.website.com
If you want to search all PDF files in this site:
site:download.website.com filetype:pdf
If you want to search all links with path download.website.com/wp-content/:
site:download.website.com inurl:/wp-content/
I hope it will help you a little bit.
Is there a tool that will automatically generate a mini-website---with automatically generated navigation---from locally-stored Markdown files?
I'm envisioning a service that will integrate with my Dropbox, look at the file structure, look at the Markdown files, and automatically create a clean little site with my pages and with hierarchical navigation.
Full-text search would be cool but not required.
Does such a tool exist?
The general term for the tool you speak of is called a static site generator. They are a new trend in web publishing and there are literally tons of them and new ones coming out all the time. Most of them have markdown support so you will have a task in choosing the best one.
My introduction to the topic was reading this blog post, An Introduction to Static Site Generators by Michael Gardner. If you're interested in the subject I would recommend giving it a read. It discusses the advantages to using such a strategy over a dynamic one, and also compares multiple generators. The comparison includes and ends up focusing on Jekyll which is probably the most popular static site generator as far as I can tell.
Also you will probably want to read Node Based Static Site Generators by Boris Mann who is also looking into Dropbox support as well. I have been looking into different static site generators as well and a few that I have noticed, but haven't had a chance to look at much:
Hexo
node-romulus
I think jekyll could do it. Jekyll is a blog-aware, static site generator in Ruby and you could host it direct on github if you want.
It sounds like Skrivr does just that: http://skrivr.com/
I'm the developer of StackEdit, a Markdown editor that can be used as a blogging client. You can use it to write your document and directly publish it in HTML format to your blog (Blogger, WordPress, Tumblr or Jekyll via through GitHub).
You can use Docusaurus the open source project from Facebook!
Simply write docs and blog posts with Markdown/MDX and Docusaurus will publish a set of static HTML files ready to serve.
I've wrote a simple plugin for Docusaurus that automatically generates the sidebar menu from file/folder structure so you even don't have to define them manually!
I'm planning a personal/portfolio web site based on WordPress. What I would like to have is a list of example webdev projects/plugins/widgets along with the source code available for browsing in the least obtrusive way (if possible to skip downloading, going to another site, etc).
The alternatives:
The simplest:
Upload the code at github, sourceforge, launchpad, google code, or similar.
Share the link to the projects source code in the respective section in my site.
The easiest:
Use an existing WordPress plugin for exposing part of the uploads directory where I can upload the projects' source code.
Use a shortcode/widget/custom page for displaying the tree view with the projects and the source code within a WordPress page(s).
The most realistic:
Write the WordPress plugin from above. From my initial research, there is no such plugin for exposing the uploads directory files in the user and/or admin section of a WordPress site.
From my initial ideas the plugin is basically a file browser with a fancy tree view and a view panel for the source code file contents
(Nice to have) AJAX-ify the plugin to view the source code contents in a DIV with syntax highlighting.
What's your take on this?
Thanks
I think what you list as the simplest option is also probably the best. You have all the tools that people are used to -- syntax coloring, etc. -- and all you have to do is make a comment or two and then link to it. This may sound silly, but there is also a certain gravitas lent to your code because it's not "just on some WordPress site".
I downloaded GraffitiCMS the other day(now open source and free), and like a lot of what I see, but what I really want to use it for, is to add CMS capabilities to an existing asp.net database/application.
Without getting bogged down with all the details of my app, can someone give me the basic 'approach' that should be taken to add custom content to Graffiti; content that won't be a 'post'?
I've seen for example, how to add custom-widgets to Graffiti - basically inherit from the widget class, compile your dll and plop it into the correct directory and it becomes part of the system. Is there a way to do something similar for the main content areas?
For simplicity sake, pretend I have a non-graffiti database with gig's of data that I want to display on the website using standard asp.net grid's and forms. I realize I could just go in and hack apart the source code to integrate my existing app, but that is likely not the correct approach.
Not looking for a complete solution her, just a pointer and what areas to investigate...thanks.
If you check out the latest source of Graffiti (or the 1.3 branch that was recently created), support was added to put widgets anywhere you want on any page. There is a new chalk function - $macros.Widget - that provides you with this ability. Dan Hounshell wrote a blog post on how you can use this new functionality:
http://danhounshell.com/blog/graffiti-cms-1-3-add-a-widget-anywhere-in-a-view-with-new-widget-macro/
If you're looking for something different than that, just let me know - we're working to make Graffiti even better for situations just like you are currently in.
What we have done to be able to integrate Graffiti CMS with our current ASP.NET projects is to create a post in Graffiti called "hidden" and then with our standard .ASPX pages we call a class in our Render Override that pulls the "hidden" post (ie: site.com/hidden/) and uses the header and footer to wrap the Graffiti theme around our custom .ASPX page. We use some HTML comments in the "hidden" post to be able to parse the header and the footer. It is kind of a hack, but has worked out really well for us.
I think you're trying to put the cart before the horse - depending on the size and amount of functionality, I would be looking to rebuild it after learning the development platform of my CMS system of choice.
I'm pretty much in the same boat right now. I have avoided Graffiti because I have to learn "Chalk" (whatever that is) and Umbraco (using XSLT for layouts is retarded). So far, this leaves me with Sitefinity at the top of my list and Telerik have just pulled the free version!
I may end up grabbing a very basic CMS which is easier to customize. I know this doesn't directly answer your question, but it may give you some food for thought :-)
I am looking for a Wiki written on ASP.NET (preferably open source and free) similar to the one on http://wiki.asp.net/.
The main feature that I like on http://wiki.asp.net/ is a hierarchical table of contents - something which is totally absent in most Wikis - which are just collections of pages connected via hyperlinks, with no place where you can see the "sitemap" of the Wiki. What I need is a more structured Wiki, with pages organized like in a file system.
Does anyone know such Wiki?
Thank you.
Try ScrewTurn wiki it is very good and open source
http://www.screwturn.eu/MainPage.ashx
Check out Deki wiki:
developer.mindtouch.com/Deki
You can see the auto generated table of contents on the left hand side. There is also a link to a full page table of contents.
Open source and very feature rich, I've used it on a few projects. There is a paid version as well, but I've never tried it.