|
23 | 23 | ## Important links |
24 | 24 |
|
25 | 25 | * **[Features](http://riteshkr.com/embed.js)** |
26 | | -* **[Full Documentation](http://riteshkr.com/embed.js/doc.html)** |
27 | | -* **[Examples](http://riteshkr.com/embed.js/examples.html)** |
| 26 | +* **[Full Documentation](https://embedjs.readme.io)** |
| 27 | +* **[Examples](https://embedjs.readme.io/docs/basic-example)** |
28 | 28 |
|
29 | 29 | ## Installation |
30 | 30 |
|
@@ -82,118 +82,6 @@ If you wan't to destroy the instance. It will also replace the processed string |
82 | 82 | x.destroy() |
83 | 83 | ``` |
84 | 84 |
|
85 | | -## Options |
86 | | -```js |
87 | | - |
88 | | -var options = { |
89 | | - //An option when set to true will use marked.js to parse markdown and convert it to HTML. |
90 | | - // Make sure you have loaded marked.js before loading embed.js if this option is set to |
91 | | - // true else the plugin will throw an error. |
92 | | - marked : false, |
93 | | - |
94 | | - // The option takes the marked.js options. |
95 | | - markedOptions : {}, |
96 | | - |
97 | | - // Instructs the plugin whether or not to embed urls/ convert urls into HTML anchor tags. |
98 | | - link : true, |
99 | | - |
100 | | - linkOptions : { |
101 | | - // Same as the target attribute in html anchor tag . supports all html supported target values. |
102 | | - target : 'self', |
103 | | - |
104 | | - // Accept array of extensions to be excluded from converting into HTML anchor links |
105 | | - exclude: ['pdf'], |
106 | | - |
107 | | - // Same as the rel attribute. |
108 | | - rel : '' |
109 | | - }, |
110 | | - |
111 | | - // Set to false if you want to disable converting emoji codes into actual emojis. |
112 | | - emoji : true, |
113 | | - |
114 | | - // Include the names of custom emojis. Eg : ['emoji1', 'emoji2']. Now they can be |
115 | | - // used using :emoji1: :emoji2: |
116 | | - customEmoji : [], |
117 | | - |
118 | | - |
119 | | - fontIcons : true, |
120 | | - customFontIcons : [], |
121 | | - highlightCode : false, |
122 | | - videoJS : false, |
123 | | - videojsOptions : { |
124 | | - fluid : true, |
125 | | - preload: 'metadata' |
126 | | - }, |
127 | | - locationEmbed : true, |
128 | | - mapOptions : { |
129 | | - mode: 'place' |
130 | | - }, |
131 | | - tweetsEmbed : false, |
132 | | - tweetOptions : { |
133 | | - maxWidth : 550, |
134 | | - hideMedia : false, |
135 | | - hideThread: false, |
136 | | - align : 'none', |
137 | | - lang : 'en' |
138 | | - }, |
139 | | - singleEmbed : false, |
140 | | - |
141 | | - // For using the open graph support (fetching site's meta data) , you will have |
142 | | - // to set up your own server due to cross domain restrictions. This option takes |
143 | | - // the api template as the string where url is a variable. |
144 | | - openGraphEndpoint : null, |
145 | | - |
146 | | - // Urls that have the array items in their string won't be processed by the |
147 | | - // openGraph API. |
148 | | - openGraphExclude : [], |
149 | | - |
150 | | - // Set to false if you want to disable embedding supported video formats. |
151 | | - videoEmbed : true, |
152 | | - |
153 | | - |
154 | | - videoHeight : null, |
155 | | - videoWidth : null, |
156 | | - videoDetails : true, |
157 | | - audioEmbed : true, |
158 | | - excludeEmbed : [], |
159 | | - inlineEmbed : [], |
160 | | - inlineText : true, |
161 | | - codeEmbedHeight : 500, |
162 | | - vineOptions : { |
163 | | - maxWidth : null, |
164 | | - type : 'postcard', //'postcard' or 'simple' embedding |
165 | | - responsive: true, |
166 | | - width : 350, |
167 | | - height : 460 |
168 | | - }, |
169 | | - |
170 | | - // The google dev auth key needed if the user is using youtube embedding or |
171 | | - // google map embedding feature of the plugin. |
172 | | - googleAuthKey : '', |
173 | | - |
174 | | - soundCloudOptions : { |
175 | | - height : 160, |
176 | | - themeColor : 'f50000', //Hex Code of the player theme color |
177 | | - autoPlay : false, |
178 | | - hideRelated : false, |
179 | | - showComments: true, |
180 | | - showUser : true, |
181 | | - showReposts : false, |
182 | | - visual : false, //Show/hide the big preview image |
183 | | - download : false //Show/Hide download buttons |
184 | | - }, |
185 | | - videoClickClass : 'ejs-video-thumb', |
186 | | - customVideoClickHandler: false, |
187 | | - beforeEmbedJSApply : function () {}, |
188 | | - afterEmbedJSApply : function () {}, |
189 | | - onVideoShow : function () {}, |
190 | | - onTweetsLoad : function () {}, |
191 | | - videojsCallback : function () {}, |
192 | | - onOpenGraphFetch : function () {}, |
193 | | - videoClickHandler : function () {} |
194 | | -} |
195 | | -``` |
196 | | - |
197 | 85 | ## Creating custom build |
198 | 86 |
|
199 | 87 | Set the features you don't want to **false** in `build.json` and then run |
|
0 commit comments