Join GitHub today
GitHub is home to over 31 million developers working together to host and review code, manage projects, and build software together.Sign up
Learn Semantic - Call For Submissions #1571
A few people have reached out about contributing to Learn Semantic.
Since there hasn't been any official channel for discussion about the technical documentation of Learn Semantic I thought I'd kick of discussion with my thoughts on the contents and structure of the site.
Site Contents (T.O.C.)
Any content not specifically marked with an author is available for contribution. Any content that already exists is open for edits, additions, & revisions unless otherwise noted.
Usage & Practices
Choosing a Topic
If anyone is interested in contributing. It should be a fairly simple process.
Writing a Guide
LearnSemantic can parse HTML and Markdown (using DocPad).
If you are comfortable with markdown but prefer not to run the server, you can just e-mail me a markdown file with a draft on your approved subject.
If you prefer to run the server you can check the readme for running the server, then simply submit a pull request with your additional guide in
Editing, Typos, etc
Many of the guides could use proofreading and editing. This is a fairly simple way to contribute if you don't have time to help with writing guides.
Adding edits can be done directly through GitHub.com using Pull Requests.
Thanks everyone. I'm excited to see what we all can do together.
This was referenced
Jan 5, 2015
IMO, there should be a section for showing off example sites built with Semantic. It would be a place to see what a website could be using Semantic, as well as give developers a good example of how to combine components and how to structure their markup correctly.
It might be the case that what I had in mind and what is described with the Ten Minute Overview might differ a bit. So I wanted to discuss this with you.
So the idea was then to create a short tutorial for the absolute beginner, and during this tutorial introduce the user to the concepts explained in the Ten Minute Overview but then just the beginning part and the what makes it different from the pack. A bit more chunkwise explanation, so to say. And then add more complex concepts in a different tutorial.
I've tried making the AirBnB landing page with only the elements that I could find in the library (and some CSS additions) and I found it extremely easy to implement. See result!
Anything that is useful to users is fine for me. I am usually more interested in conceptual than practical and I'm sure that comes across in the gaps in documentation.
A guide to building a basic page with semantic ui is quite fine as a choice. I can adapt the legacy docs into another section
Perhaps take users through the whole process of creating a web page with Semantic: from
An airbnb homepage clone or something like that is great for a tutorial. Mostly I just want to make sure that it is easy to follow and useful. The easiest way is just to send me a draft when you have something so I can give you immediate feedback.
Hello, I use this in my sites:<script src="http://oss.maxcdn.com/jquery/2.1.4/jquery.min.js"></script> <script src="http://oss.maxcdn.com/semantic-ui/2.1.6/semantic.min.js"></script>
I find usefull to use a CDN to load the libs, and the expert documentation mention the ones above. It will be awesome if you point that somewhere visible, because the install part using npm is weird for someone coming from bootstrap or a similar framework and we all are used to just paste the CDN tags.