Comments (3)
Note that user names rules are here:
https://github.com/shinnn/github-username-regex
According to the form validation messages on Join Github page,
- Github username may only contain alphanumeric characters or hyphens.
- Github username cannot have multiple consecutive hyphens.
- Github username cannot begin or end with a hyphen.
- Maximum is 39 characters.
For the module names, they are here:
https://github.com/elm/compiler/blob/38670361cd4b9f9f09621f3f5a7dbe07ebde7bf2/compiler/src/Elm/Package.hs#L316
So from a quick glance:
- < 256 characters
- no
--
inside - no
-
at the beginning or at the end - only lower case
- no number at the beginning
from elm-doc-preview.
For user_name/dir
, were you thinking about the logged-in user for the user name?
This would make sense.
Apparently, it is be available cross-plaform with:
https://nodejs.org/api/os.html#os_os_userinfo_options.
from elm-doc-preview.
Perhaps we could transform the directory name into something friendly?
We could indeed, I have put above the restrictions to respect.
I agree that the combination OS_user/current_directory
should be more useful than my/application
for the large majority of cases.
from elm-doc-preview.
Related Issues (20)
- Add an option to check whether the documentation is correct HOT 2
- Maintain scroll position when hot reloading? HOT 4
- Error: ENOENT: no such file or directory, mkdir ... when building application doc
- The doc server can't find `elm.json` in some folder structures HOT 1
- `npm audit` warns about vulnerabilites HOT 3
- works nicely HOT 3
- Feature request: Generate docs.json, then exit HOT 1
- Add a CLI option to check whether application documentation is correct HOT 5
- Doc server quits with error below after 10-30 seconds. HOT 4
- elm-doc-preview can get confused if multiple files are modified simultaneously HOT 1
- npm complains about peer dependencies HOT 8
- Provide a way to expose all modules in an application HOT 8
- Online version should mention that this works also for applications
- elm-doc-preview crashes after 30 seconds HOT 4
- Static site generation HOT 5
- modules not shown HOT 7
- No output seen when doc format is missing/has errors
- Handle documentation for unexposed code
- Configurable binding address with loopback as default
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 elm-doc-preview.