{"id":13527641,"url":"https://github.com/nkronlage/JavaScripture","last_synced_at":"2025-04-01T09:32:00.835Z","repository":{"id":16551023,"uuid":"19304706","full_name":"nkronlage/JavaScripture","owner":"nkronlage","description":"Interactive JavaScript API Reference","archived":false,"fork":false,"pushed_at":"2024-05-01T11:57:46.000Z","size":6078,"stargazers_count":229,"open_issues_count":19,"forks_count":41,"subscribers_count":20,"default_branch":"master","last_synced_at":"2024-11-02T12:35:05.510Z","etag":null,"topics":["hacktoberfest"],"latest_commit_sha":null,"homepage":"http://www.javascripture.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nkronlage.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2014-04-30T07:23:14.000Z","updated_at":"2024-10-27T10:13:06.000Z","dependencies_parsed_at":"2024-11-02T12:32:19.150Z","dependency_job_id":null,"html_url":"https://github.com/nkronlage/JavaScripture","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nkronlage%2FJavaScripture","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nkronlage%2FJavaScripture/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nkronlage%2FJavaScripture/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nkronlage%2FJavaScripture/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nkronlage","download_url":"https://codeload.github.com/nkronlage/JavaScripture/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246616284,"owners_count":20806099,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hacktoberfest"],"created_at":"2024-08-01T06:01:55.163Z","updated_at":"2025-04-01T09:31:55.821Z","avatar_url":"https://github.com/nkronlage.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"JavaScripture\n=============\n[JavaScripture.com](http://www.javascripture.com) is designed to be\nthe fastest and easiest to use JavaScript API reference site by\nproviding simple descriptions and interactive examples.\n\nContributing to the Documentation\n---------------------------------\nJavaScripture's HTML is generated from a series of text files that\ncontain the API, descriptions, and examples. Each text file describes\none JavaScript type.  The text files are grouped in folders under the\ncontent/ directory. These folders generate the sets available in the\ndrop down under the search box on the website.\n\n### Copyright and License\n\nBefore contributing, be aware that the examples on the site are\nin the [public domain](http://creativecommons.org/publicdomain/zero/1.0/).\nThe remaining documentation and code are available under the \n[Creative Commons Attribution-ShareAlike license](http://creativecommons.org/licenses/by-sa/2.5/).\nBy contributing, you agree that the works produced are your own and\nto release the works under the corresponding license(s) listed above.\n\n### Getting the code and making changes\n\nTo contribute, you first need to fork the JavaScripture repository into\nyour GitHub account where you will make your local changes.  Then\nyou will issue a pull request to get the get your changes into the main \nrepository that the website is built out of.\n\nHere are some helpful links to the GitHub documentation on using GitHub.\n* [Fork a Repo](https://help.github.com/articles/fork-a-repo)\n* [Pull Requests](https://help.github.com/articles/using-pull-requests)\n\n### Building the documentation\n\nAfter forking the repository (or making changes to your repository), you can \nbuild the site's html files.\n\nPrerequisites for building\n* [Node](http://nodejs.org/download/)\n* Run: npm install\n\nTo build the documentation, run:\n\n* node build.js\n\nFrom the root folder. The generated files are in the docs/ folder.\n\n### Documentation File Format\nThe information for each type is stored in a .jsdoc file.  This is a\ncustom file format that describes a JavaScript type.\n\nHere's a simplified example (see content/JavaScript/Array.jsdoc for the complete file):\n\n    Array : Object\n\n    Arrays are containers ...\n    \n    Spec:\n    http://...\n\n    ----\n    new Array(length : Number) : Array\n    \n    Creates a new Array...\n    \n    \u003cexample\u003e\n    console.log(new Array(5).length);\n    \u003c/example\u003e\n    \n    Spec: \n    http://...\n    \n    ----\n    instance.length : Number\n    \n    The number of items in ...\n    \n    \u003cexample\u003e\n    console.log(new Array(10).length);\n    \u003c/example\u003e\n    \n    Spec:\n    http://...\n    \n\nThe file is broken into separate sections for each member of the type. \nThe sections are separated by a line containing four dashes: \"----\"\n\n#### Member Description\n\nThe first line in the first section is the type described in the file.\nThe type is followed by a \":\" and the base type.\n\nAfter first line in the other sections are the member that section describes.  The format for this line can be in any of the following:\n* *Type*(*parameterList*) : *ReturnType*\n    * Describes the parameters and return value of calling the function without `new`. \n    * Example: \n        * [Date() : String](http://www.javascripture.com/Date#Date)\n* new *Type*(*parameterList*) : *Type*\n    * Describes the parameters for the type when constructing an instance using the `new` keyword.\n    * Example:\n        * [new Array(length : Number) : *Array*](http://www.javascripture.com/Array#new_Array_Number)\n* instance.*propertyName* : *PropertyType*\n    * Describes a property on an instance of the type.\n    * Example:\n        * [instance.length : Number](http://www.javascripture.com/Array#length)\n* prototype.*methodName*(*parameterList*) : *ReturnType*\n    * Describes a method on an instance of the type.\n    * Example:\n        * [prototype.join(\\[separator=',' : String\\]) : String](http://www.javascripture.com/Array#join)\n* *typePropertyName* : *Type*\n    * Describes a property on the type.\n    * Example:\n        * [MAX_VALUE : Number](http://www.javascripture.com/Number#MAX_VALUE)\n* *typeMethodName*(*parameterList*) : *ReturnType*\n    * Describes a method on the type.\n    * Example:\n        * [isArray(value : Object) : Boolean](http://www.javascripture.com/Array#isArray)\n\nThe *parameterList* is a comma separated list of \"name : Type\" pairs (or empty if there are parameters).  Optional parameters should be wrapped in []. After the name, you can specify \" = value\" to specify what value is used if the parameter is not specified.  Here are some examples:\n* [isArray(value : Object) : Boolean](http://www.javascripture.com/Array#isArray)\n* [RegExp(pattern : String, \\[flags : String\\]) : RegExp](http://www.javascripture.com/RegExp#RegExp_String_String)\n* [new Date(year : Number, month : Number, \\[date = 1 : Number, \\[hours = 0 : Number, \\[minutes = 0 : Number, \\[seconds = 0 : Number, \\[milliseconds = 0 : Number\\]\\]\\]\\]\\]) : Date](http://www.javascripture.com/Date#new_Date_Number_Number_Number_Number_Number_Number_Number)\n\nIf the method takes a function as a parameter, such as a callback, you can specify parameters and return value such as:\n* [prototype.forEach(callback(item : Object, index : Number, array: Array) : undefined, \\[thisArg : Object\\]) : undefined](http://www.javascripture.com/Array#forEach)\n\n\nIf the method takes an object with several properties, you can define the expected properties like:\n\n    new Blob( \\ \n        blobParts : Array, \\\n        [blobPropertyBag : { \\\n            type : String /* A valid mime type such as **'text/plain'** */, \\ \n            endings = 'transparent' : String /* Must be either **'transparent'** or **'native'** */ \\ \n        }]) : Blob\n\n#### Description\nAfter the first line of the section comes the description text for that\nmember. In the description area, there is some special syntax to add\nlinks, code tags and examples.\n\n* Use %%*link*|*Link Description*%% to generate \u0026lt;a href=\"link\"\u0026gt;Link Description\u0026lt;/a\u0026gt;\n* Use \\*\\* *Code* \\*\\* to generate \u0026lt;code\u0026gt;Code\u0026lt;/code\u0026gt;\n\nAlso inside the description section you can add an example using the format:\n\n    \u003cexample\u003e\n    console.log(10);\n    \u003c/example\u003e\n\nOr\n\n    \u003chtmlexample\u003e\n    \u003cdiv\u003eHi\u003c/div\u003e\n    \u003cscript\u003e\n      console.log(10);\n    \u003c/script\u003e\n    \u003c/htmlexample\u003e\n\nThe \u0026lt;example\u0026gt; generates an interactive example that only contains\na text output area. \u0026lt;htmlexample\u0026gt; generates an interactive\nexample that has an iframe to display the HTML and a text area below\nthat to display the console output.\n\n#### Metadata\n\nAfter the description comes additional metadata for the member.  The metadata is described by:\n\n\u003cpre\u003e\u003ccode\u003e\u003cem\u003eMetadataName\u003c/em\u003e:\n\u003cem\u003eMetadataValue\u003c/em\u003e\n\u003c/code\u003e\u003c/pre\u003e\n\nThe possible MetadataNames are:\n* Spec - the value should be the link to the specification \n* ReadOnly - value should be true if the property is read only.  Defaults to false.\n* Value - the value of the property such as [seen here](http://www.javascripture.com/XMLHttpRequest#DONE)\n\nPlaces For Contribution\n-----------------------\nAny contributions would be greatly appreciated.\n\nHere are some ideas for improvements:\n* Spelling, grammar, and other editorial issues\n* Add missing descriptions and examples\n* Add any missing types\n* Switch documentation format to Markdown\n* Translate in other languages than English\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnkronlage%2FJavaScripture","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnkronlage%2FJavaScripture","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnkronlage%2FJavaScripture/lists"}