Comments (5)
I went with "... to a GitHub wiki"
The reason is that, with the correct access for a token and the repository
input, you can publish to any repo's wiki, such as from your personal repo to an org.
from actions-wiki.
π most resembles GitHub's Wiki icon, so I think I'll go with that. Thanks for the suggestions!
from actions-wiki.
My personal philosophy is to keep the README as readable as possible in plain-text. In fact, I think Markdown is generally a great guideline for making readable plain-text. There's also accessibility to consider -- ideally, the README should render to something that screen-readers can use.
I've never formally defined these self-imposed rules, but here's a basic idea:
- Images are cool, but shouldn't be required for reading and understanding the docs. Frequently used badges, like CI badges, are an exception.
- Little to no HTML in the Markdown. READMEs with
<p align="center">
definitely look prettier when rendered, but I think it harms plain-text readability. - Text styling should be used semantically. E.g.
## header
isn't just a way to make big, eye-catching text, but to define a section, which is helpful for screen-readers.
That's pretty much all I can think of off the top of my head. I wouldn't worry too much about it -- we can discuss the trade-offs between plain-text readability and rendered prettiness further π
from actions-wiki.
Add an emoji to the description
BTW I'm totally up for an emoji, if you have any suggestions π
from actions-wiki.
BTW I'm totally up for an emoji, if you have any suggestions π
I think one of these: πππππ fits the idea of a "docs" sort of emoji. For the description I used this in the readme draft #13
π Deploy docs from your source tree to the GitHub wiki
now that I read it again that "the" should be "your"
π Deploy docs from your source tree to your GitHub wiki
ill have to fix that in my pr
from actions-wiki.
Related Issues (20)
- Add more informative error message when wiki doesn't exist HOT 6
- Add a header image to readme HOT 2
- Add workflow extension to devcontainer
- Add README.txt or something for locally cloned wikis HOT 4
- Support ignoring files in the wiki folder HOT 3
- Add URL to GitHub Marketplace to repo metadata
- Fix test script HOT 4
- Make GitHub token inputs/behaviour work like other ecosystem actions HOT 10
- [Milestone] v1 HOT 4
- Support bare user/repo slugs in repository input field HOT 6
- Add github-server-url input
- Create v0.3.0
- path=. confusion HOT 4
- Merge @jcbhmr's changes from github-wiki-action HOT 1
- Support non-master default branch HOT 2
- Bug: Not handle no-changed correctly HOT 1
- Rewrite in TS/JS HOT 7
- Force-push new history with a single commit for the default deployment strategy HOT 1
- Consider reducing config clutter? HOT 1
- Update the node runtime to node 20
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 actions-wiki.