Comments (2)
Hi there, and thanks for quick response!
I'm just trying to make my theme "standard-compliant". I think you might be a tick more explicit about what makes a theme to pass into submission stage.
You could, for instance, add a page to a project to test against the installation defaults. It shouldn't then contain any elements that require non-default configuration to work properly. This would be a useful indicator. For instance, I've discovered that tables without styling look ugly and fixed it.
Then, you might say: now run a server with this config, and see how your theme performs with <abbr>
, <mark>
, etc.
So, is it then OK to invite user to recursively clone a project repository that includes my theme as a git submodule?
from hugobasicexample.
Hello Toomas,
based on your question I assume you're asking prior of a theme submussion to www.github.com/gohugoio/hugoThemes, right? It might help to know a bit more about the context of your question, i.e. what you're trying to do.
The hugoBasicExample is used in place of the exampleSite directory for theme demos on www.themes.gohugo.io if the latter one is not provided. The setup in this repository meant to be minimal while covering a wide range of themes as possible.
My theme relies on pygmentsUseClasses = true et al. The test project doesn't, and so inline styling is applied. As a result, the appearance is a bit ugly. Is it acceptable to instruct the user to configure the project accordingly?
This repo isn't a static framework and can't cover all corner cases, especially when themes require a custom setup or configuration. Of course it is acceptable to let users configure the project according to your instructions. Pygments is likely configured the way it is because most of the users might use Hugo's built-in syntax highlighter Chroma nowadays.
In case you're planning to submit a new theme it's also possible submit a config file in the exampleSite directory to tweak a theme demo. In case your theme is more complex custom content can be used as well to cirumvent issues arising due to limitations of the hugoBasicExample.
from hugobasicexample.
Related Issues (20)
- Failed to extract shortcode: template for shortcode "math" not found HOT 2
- Translated Posts HOT 3
- Duplicated pages in taxonomy list page (because of symlinks) HOT 3
- This example project should not require unsafe settings HOT 6
- KaTeX inline math being rendered as block (with Goldmark) HOT 1
- Sorry, it is a mistake issue, plz delete it.
- archives.md HOT 2
- Multilingual Example HOT 1
- .Site.Author requires a map, this repo uses a flat "author = " variable
- do clone
- How to change the icon of the menu bar?
- Installing hugo on windows by cloning from github HOT 1
- how can i deploy it to github or gitlab i tried abolult 3 hours and i faild HOT 1
- No content when trying hugoBasicExample?
- ID-only syntax deprecated in the twitter_simple shortcode
- Archive this repository
- When I visit http://localhost:1313, it shown me 'Page Not Found' HOT 1
- theme broken on github pages
- This 'example' is very broken HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from hugobasicexample.