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!
Related
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.
I am a newbie in Web designing. I learnt about templates that are available online that people can purchase and change the content according to their requirements.
One thing puzzled me. Why do people purchase themes when they can copy the code using VIEW SOURCE option. I have tried searching the answer but google has failed me.
Also, If I am not using Wordpress, can still I use Wordpress themes for my website.
Thanks!!
Because, while often technologically possible, that's still copyright infringement.
Because WordPress themes usually are more than just their raw HTML/CSS/JS. The PHP logic is frequently pretty complex and important.
1.) Copying source code is stealing. If you're copying the html/css, you'll probably copy the images, too. Definitely could be legal issues in that.
2.) If you decide to try and steal it anyways, you'll notice in a lot of cases they've used Iframes or JavaScript to pull the code in from elsewhere, where you do not have access to it.
3.) Copying CSS and HTML wouldn't do much for a Wordpress site. You wont' be able to copy any of the server-side stuff.
4.) You can't really use the theme because a Wordpress theme comes with functions and much more. You could use the CSS with a lot of hacking.
We can only copy the Html form either full encoding of the sites ie, ref style sheet.
According to the law, copy web design structure, encoding is a crime and Definitely could be legal issues in that.
If you are a newbie in web designing, I suggest you some of the top web designing blog that you should follow.
https://blog.hubspot.com/marketing/web-design-tips
https://blog.techreshape.com/5-web-design-tips-for-a-better-website-user-experience/
I'm working on a project to rebuild news.byu.edu in Wordpress, and trying to figure out how best to import the articles from the current build (in ASP.net) into a .dev site I'm building with ServerPress's DesktopServer.
Unfortunately, the RSS feed on the site only contains summaries of the articles, so doing an RSS import of that is not particularly useful. I do have access to the back end of the news site. Best I can see it, my options are:
Find a WordPress plugin that will handle custom import of individual articles (not the RSS feed) on a large scale. This would be ideal, but I have yet to find one that suits my needs.
Rewrite the RSS feed generator on the news site to include all other pertinent information, and not just summaries, then import that. Problem here is that there are a lot of articles, and I'm not sure if making the generator display all of them is a good idea.
Write a script to parse the current site's archives and aggregate them into a single .xml that I then import. This seems like it may be a waste of time, as 2 may well be shorter to implement.
Essentially, my question is, what would be the least time-consuming solution?
Probably the best solution to this will be to use WordPress's HTML Import plugin. This allows for importing selected HTML content from files of various extensions.
Use the recommended SiteSucker app found in the user guide for HTML Import to download the archives of the site. Then set up the configuration of HTML Import to select whatever desired part you want from each page. This technique will work for importing any content from any site to make posts.
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".
This is related to my previous question regarding serving static html files but that doesn't seem to be a good solution,
I want to make a fully customizable ASP.NET MVC application as a hosted service. See allowing the user to customize the look/feel of their own page but it is still dynamic, meaning the data is hosted in the central database.
I looked at the "theme" or "skin" in ASP.NET but I don't think it is customizable enough. It seems only the developer can add new themes. I want to have something like the theme editor in WordPress so you can just change the look in anyway you want from a web-based interface.
I wonder how the theme files will be stored for the popular blogging platform? Are they stored in database or a file in filesystem? I prefer to store it in database, because if it is in filesystem it will have scalability problem. Each user will be tired to a particular web server and I have to determine how much disk space for each webserver.
I thought of doing something like the old MovableType, to generate static HTML when you add new post. This solution is problematic as well, because the flexibility depends on the complexity of the template engine.
Ideas? Suggestions?
Thanks!
"Fully customizable" is the most elusive of the white whales ;-)
I see your question is old, but none the less;
first I'd recommend defining some very clear,
and cohesive rules governing just what the "bottom-line" is,
or an inheritable template of sorts.
You get a pretty good impression of what might be useful during developing, I'd guess.
Next; just what and how is the customizing supposed to be presented and achieved?
The inherit ASP.NET custom custard, Web Parts, need quite some cajoling to behave in MVC views :
https://stackoverflow.com/questions/1106629/using-webparts-in-an-mvc-application
If you're leaning more towards customizable appearance (theme's n' skin's),
how about having a CSS file for each user, saves like a charm as VARCHAR(MAX), and can easily be inserted
in e.g. your Master Page's head.
The theme editor in WordPress simply allows you to edit Theme PHP files...
You can do it exactly like in wordpress but instead of editing PHP files your theme is composed of a set of aspx\ascx files without code-behinds...