From 79127f3503d3896f93f5dacc016d5bacfae05c4b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E3=83=9D=E3=83=BC=E3=83=AB=20=E3=82=A6=E3=82=A7=E3=83=83?= =?UTF-8?q?=E3=83=96?= Date: Mon, 25 Jun 2018 12:52:05 -0500 Subject: [PATCH] Formatting and more styling of /api --- content/.vuepress/components/Slate.vue | 62 +- content/.vuepress/public/api.md | 950 ++++++++---------- .../.vuepress/scss/partials/_slate_icons.scss | 38 - .../.vuepress/scss/partials/_slate_style.scss | 523 ---------- .../scss/partials/_slate_variables.scss | 146 --- 5 files changed, 498 insertions(+), 1221 deletions(-) delete mode 100644 content/.vuepress/scss/partials/_slate_icons.scss delete mode 100644 content/.vuepress/scss/partials/_slate_style.scss delete mode 100644 content/.vuepress/scss/partials/_slate_variables.scss diff --git a/content/.vuepress/components/Slate.vue b/content/.vuepress/components/Slate.vue index 035cc05..2b95e3d 100644 --- a/content/.vuepress/components/Slate.vue +++ b/content/.vuepress/components/Slate.vue @@ -187,10 +187,6 @@ @import "../scss/init/colors"; @import "../scss/init/mixins"; - // @import "../scss/partials/slate_variables"; - // @import "../scss/partials/slate_icons"; - // @import "../scss/partials/slate_style"; - .slate { width: 100%; height: 100%; position: relative; @@ -234,6 +230,52 @@ float: right; grid-template-columns: repeat(auto-fit, minmax(50%, 1fr)); width: calc(100% - 200px); + + h1 { + font-size: 1.5rem; + margin-bottom: 0.5rem; + } + + h2 { + font-size: 1.25rem; + margin-bottom: 0.5rem; + } + + h3 { + font-size: 1.15rem; + margin-bottom: 0.25rem; + } + + p { + font-size: 1rem; + line-height: 1.5; + margin-bottom: 1rem; + } + + table { + border: 1px solid rgba($white, 0.1); + border-radius: 0.3rem; + border-spacing: 0; + font-size: 0.8rem; + line-height: 1.33; + width: 100%; + } + + thead { + display: none; + } + + th, td { + padding: 0.5rem 1rem 0.5rem 0.5rem; + } + + th { + border-bottom: 1px solid rgba($white, 0.1); + } + + tr:nth-child(even) { + background-color: rgba($white, 0.1); + } } .api__content__body, @@ -246,8 +288,18 @@ } .api__content__example { - background-color: $black; + background-color: mix($gray, $black, 10%); border-bottom: 1px solid rgba($white, 0.1); color: $white; + + pre { + margin-bottom: 1rem; padding: 1rem; + + background-color: $black; + border-radius: 0.3rem; + line-height: 1.33; + overflow-x: auto; + overflow-y: hidden; + } } diff --git a/content/.vuepress/public/api.md b/content/.vuepress/public/api.md index 43affe8..932466d 100644 --- a/content/.vuepress/public/api.md +++ b/content/.vuepress/public/api.md @@ -25,13 +25,13 @@ Returns: (bool) true if successful ``` -### Arguments +Arguments: -| Parameter | Description | -|:------------|:------------------------------------------------------------------------| -| blob_hash | (str) announce a blob, specified by blob_hash | -| stream_hash | (str) announce all blobs associated with stream_hash | -| sd_hash | (str) announce all blobs associated with sd_hash and the sd_hash itself | +| Parameter | Description | +|:------------|:--------------------------------------------------------------------------| +| blob_hash | (str) announce a blob, specified by blob hash | +| sd_hash | (str) announce all blobs associated with `sd_hash` and the sd hash itself | +| stream_hash | (str) announce all blobs associated with `stream_hash` | ::: @@ -53,13 +53,13 @@ Returns: } ``` -### Arguments +Arguments: | Parameter | Description | |:---------------|:-----------------------------------------------------------| | blob_hash | (str) check availability for this blob hash | -| search_timeout | (int) how long to search for peers for the blob in the dht | | blob_timeout | (int) how long to try downloading from a peer | +| search_timeout | (int) how long to search for peers for the blob in the dht | ::: @@ -77,7 +77,7 @@ Returns: (str) Success/fail message ``` -### Arguments +Arguments: | Parameter | Description | |:------------|:--------------------------------------| @@ -99,14 +99,14 @@ Returns: (str) Success/Fail message or (dict) decoded data ``` -### Arguments +Arguments: -| Parameter | Description | -|:---------------------|:------------------------------------------------------------------------------------------------------------------| -| blob_hash *required* | (str) blob hash of the blob to get | -| timeout | (int) timeout in number of seconds | -| encoding | (str) by default no attempt at decoding is made, can be set to one of the following decoders: "json" | -| payment_rate_manager | (str) if not given the default payment rate manager will be used.supported alternative rate managers: "only-free" | +| Parameter | Description | +|:---------------------|:-------------------------------------------------------------------------------------------------------------------| +| blob_hash *required* | (str) blob hash of the blob to get | +| encoding | (str) by default no attempt at decoding is made, can be set to one of the following decoders: "json" | +| payment_rate_manager | (str) if not given the default payment rate manager will be used. Supported alternative rate managers: "only-free" | +| timeout | (int) timeout in number of seconds | ::: @@ -124,17 +124,17 @@ Returns: (list) List of blob hashes ``` -### Arguments +Arguments: | Parameter | Description | |:------------|:--------------------------------------| -| needed | (bool) only return needed blobs | | finished | (bool) only return finished blobs | -| uri | (str) filter blobs by stream in a uri | -| stream_hash | (str) filter blobs by stream hash | -| sd_hash | (str) filter blobs by sd hash | -| page_size | (int) results page size | +| needed | (bool) only return needed blobs | | page | (int) page of results to return | +| page_size | (int) results page size | +| sd_hash | (str) filter blobs by sd hash | +| stream_hash | (str) filter blobs by stream hash | +| uri | (str) filter blobs by stream in a uri | ::: @@ -152,7 +152,7 @@ Returns: (list) reflected blob hashes ``` -### Arguments +Arguments: | Parameter | Description | |:-----------------|:------------------------| @@ -190,7 +190,7 @@ Returns: (dict) Requested block ``` -### Arguments +Arguments: | Parameter | Description | |:---------------------|:-------------------------------------| @@ -213,7 +213,7 @@ Returns: (str) Serialized certificate information ``` -### Arguments +Arguments: | Parameter | Description | |:--------------------|:-------------------------------------------| @@ -235,7 +235,7 @@ Returns: (dict) Result dictionary ``` -### Arguments +Arguments: | Parameter | Description | |:---------------------------------------|:-----------------------| @@ -254,7 +254,7 @@ Get certificate claim infos for channels that can be published to. Returns: ``` -(list) ClaimDict, includes 'is_mine' field to indicate if the certificate claim is in the wallet. +(list) ClaimDict, includes "is_mine" field to indicate if the certificate claim is in the wallet. ``` ::: @@ -273,20 +273,20 @@ Returns: (dict) Dictionary containing result of the claim { + "claim_id": (str) claim ID of the resulting claim + "fee": (float) fee paid for the claim transaction + "nout": (int) nout of the resulting claim "tx": (str) hex encoded transaction "txid": (str) txid of resulting claim - "nout": (int) nout of the resulting claim - "fee": (float) fee paid for the claim transaction - "claim_id": (str) claim ID of the resulting claim } ``` -### Arguments +Arguments: | Parameter | Description | |:------------------------|:--------------------------------------------| -| channel_name *required* | (str) name of the channel prefixed with "@" | | amount *required* | (float) bid amount on the channel | +| channel_name *required* | (str) name of the channel prefixed with "@" | ::: @@ -304,18 +304,18 @@ Returns: (dict) Dictionary containing result of the claim { - "txid": (str) txid of resulting transaction "fee": (float) fee paid for the transaction + "txid": (str) txid of resulting transaction } ``` -### Arguments +Arguments: -| Parameter | Description | -|:------------|:---------------------------------------| -| claim_id | (str) claim_id of the claim to abandon | -| txid | (str) txid of the claim to abandon | -| nout | (int) nout of the claim to abandon | +| Parameter | Description | +|:------------|:-----------------------------------| +| claim_id | (str) id of the claim to abandon | +| nout | (int) nout of the claim to abandon | +| txid | (str) txid of the claim to abandon | ::: @@ -333,24 +333,24 @@ Returns: (dict) State of claims assigned for the name { - "claims": (list) list of claims for the name, + "claims": (list) list of claims for the name [{ - "amount": (float) amount assigned to the claim, - "claim_id": (str) claim ID of the claim, - "effective_amount": (float) total amount assigned to the claim, including supports, - "height": (int) height of block containing the claim, - "nout": (int) nout of the claim, - "permanent_url": (str) permanent url of the claim, - "supports": (list) a list of supports attached to the claim, - "txid": (str) txid of the claim, + "amount": (float) amount assigned to the claim + "claim_id": (str) claim ID of the claim + "effective_amount": (float) total amount assigned to the claim, including supports + "height": (int) height of block containing the claim + "nout": (int) nout of the claim + "permanent_url": (str) permanent url of the claim + "supports": (list) a list of supports attached to the claim + "txid": (str) txid of the claim "value": (str) the value of the claim }], - "last_takeover_height": (int) the height of last takeover for the name, + "last_takeover_height": (int) the height of last takeover for the name "supports_without_claims": (list) supports without any claims attached to them } ``` -### Arguments +Arguments: | Parameter | Description | |:----------------|:-------------------------------------------| @@ -372,48 +372,48 @@ Returns: { resolved channel uri: { If there was an error: - 'error': (str) error message + "error": (str) error message - 'claims_in_channel': the total number of results for the channel, + "claims_in_channel": the total number of results for the channel If a page of results was requested: - 'returned_page': page number returned, - 'claims_in_channel': [{ - 'absolute_channel_position': (int) claim index number in sorted list of + "returned_page": page number returned + "claims_in_channel": [{ + "absolute_channel_position": (int) claim index number in sorted list of claims which assert to be part of the channel - 'address': (str) claim address, - 'amount': (float) claim amount, - 'effective_amount': (float) claim amount including supports, - 'claim_id': (str) claim id, - 'claim_sequence': (int) claim sequence number, - 'decoded_claim': (bool) whether or not the claim value was decoded, - 'height': (int) claim height, - 'depth': (int) claim depth, - 'has_signature': (bool) included if decoded_claim - 'name': (str) claim name, - 'supports: (list) list of supports [{ - 'txid': (str) txid, - 'nout': (int) nout, - 'amount': (float) amount - }], - 'txid': (str) claim txid, - 'nout': (str) claim nout, - 'signature_is_valid': (bool), included if has_signature, - 'value': ClaimDict if decoded, otherwise hex string + "address": (str) claim address + "amount": (float) claim amount + "claim_id": (str) claim id + "claim_sequence": (int) claim sequence number + "decoded_claim": (bool) whether or not the claim value was decoded + "depth": (int) claim depth + "effective_amount": (float) claim amount including supports + "has_signature": (bool) included if decoded_claim + "height": (int) claim height + "name": (str) claim name + "nout": (str) claim nout + "signature_is_valid": (bool), included if has_signature + "supports": (list) list of supports [{ + "amount": (float) amount + "nout": (int) nout + "txid": (str) txid + }] + "txid": (str) claim txid + "value": ClaimDict if decoded, otherwise hex string }] } } ``` -### Arguments +Arguments: | Parameter | Description | |:---------------|:-------------------------------------------------------------------------------------------| -| uri *required* | (str) uri of the channel | -| uris | (list) uris of the channel | | page | (int) which page of results to return where page 1 is the first page, defaults to no pages | | page_size | (int) number of results in a page, default of 10 | +| uri *required* | (str) uri of the channel | +| uris | (list) uris of the channel | ::: @@ -428,33 +428,26 @@ List my name claims. Returns: ``` - (list) List of name claims owned by user +(list) List of name claims owned by user - [ - { - 'address': (str) address that owns the claim - 'amount': (float) amount assigned to the claim - 'blocks_to_expiration': (int) number of blocks until it expires - 'category': (str) "claim", "update" , or "support" - 'claim_id': (str) claim ID of the claim - 'confirmations': (int) number of blocks of confirmations for the claim - 'expiration_height': (int) the block height which the claim will expire - 'expired': (bool) true if expired, false otherwise - 'height': (int) height of the block containing the claim - 'is_spent': (bool) true if claim is abandoned, false otherwise - 'name': (str) name of the claim - 'permanent_url': (str) permanent url of the claim, - 'txid': (str) txid of the cliam - 'nout': (int) nout of the claim - 'value': (str) value of the claim - } - ] +[{ + "address": (str) address that owns the claim + "amount": (float) amount assigned to the claim + "blocks_to_expiration": (int) number of blocks until it expires + "category": (str) "claim", "update", or "support" + "claim_id": (str) claim ID of the claim + "confirmations": (int) number of blocks of confirmations for the claim + "expiration_height": (int) the block height which the claim will expire + "expired": (bool) true if expired, false otherwise + "height": (int) height of the block containing the claim + "is_spent": (bool) true if claim is abandoned, false otherwise + "name": (str) name of the claim + "nout": (int) nout of the claim + "permanent_url": (str) permanent url of the claim + "txid": (str) txid of the claim + "value": (str) value of the claim +}] ``` - -### Arguments - -| Parameter | Description | -|| ::: @@ -469,22 +462,22 @@ Support a name claim. Returns: ``` - (dict) Dictionary containing result of the claim +(dict) Dictionary containing result of the claim - { - txid: (str) txid of resulting support claim - nout: (int) nout of the resulting support claim - fee: (float) fee paid for the transaction - } +{ + fee: (float) fee paid for the transaction + nout: (int) nout of the resulting support claim + txid: (str) txid of resulting support claim +} ``` -### Arguments +Arguments: -| Parameter | Description | -|:--------------------|:---------------------------------------| -| name *required* | (str) name of the claim to support | -| claim_id *required* | (str) claim_id of the claim to support | -| amount *required* | (float) amount of support | +| Parameter | Description | +|:--------------------|:-----------------------------------| +| amount *required* | (float) amount of support | +| claim_id *required* | (str) id of the claim to support | +| name *required* | (str) name of the claim to support | ::: @@ -499,26 +492,25 @@ Renew claim(s) or support(s). Returns: ``` - (dict) Dictionary where key is the the original claim's outpoint and - value is the result of the renewal +(dict) Dictionary where key is the the original claim's outpoint and value is the result of the renewal - { - outpoint: { - 'tx': (str) hex encoded transaction - 'txid': (str) txid of resulting claim - 'nout': (int) nout of the resulting claim - 'fee': (float) fee paid for the claim transaction - 'claim_id': (str) claim ID of the resulting claim - } +{ + "outpoint": { + "claim_id": (str) claim ID of the resulting claim + "fee": (float) fee paid for the claim transaction + "nout": (int) nout of the resulting claim + "tx": (str) hex encoded transaction + "txid": (str) txid of resulting claim } +} ``` -### Arguments +Arguments: | Parameter | Description | |:--------------------|:------------------------------------------------------------| -| outpoint *required* | (str) outpoint of the claim to renew | | height *required* | (str) update claims expiring before or at this block height | +| outpoint *required* | (str) outpoint of the claim to renew | ::: @@ -533,24 +525,24 @@ Send a name claim to an address. Returns: ``` - (dict) Dictionary containing result of the claim +(dict) Dictionary containing result of the claim - { - 'tx' : (str) hex encoded transaction - 'txid' : (str) txid of resulting claim - 'nout' : (int) nout of the resulting claim - 'fee' : (float) fee paid for the claim transaction - 'claim_id' : (str) claim ID of the resulting claim - } +{ + "claim_id": (str) claim ID of the resulting claim + "fee": (float) fee paid for the claim transaction + "nout": (int) nout of the resulting claim + "tx": (str) hex encoded transaction + "txid": (str) txid of resulting claim +} ``` -### Arguments +Arguments: | Parameter | Description | |:--------------------|:---------------------------------------------------------------------------------------| -| claim_id *required* | (str) claim_id to send | | address *required* | (str) address to send the claim to | -| amount | (int) Amount of credits to claim name for, defaults to the current amount on the claim | +| amount | (int) amount of credits to claim name for, defaults to the current amount on the claim | +| claim_id *required* | (str) claim id to send | ::: @@ -558,39 +550,39 @@ Returns: ::: api__content__body ## claim_show -Resolve claim info from txid/nout or with claim ID. +Resolve claim info from nout/txid or with claim ID. ::: ::: api__content__example Returns: ``` - (dict) Dictionary containing claim info as below, +(dict) Dictionary containing claim info as below - { - 'txid': (str) txid of claim - 'nout': (int) nout of claim - 'amount': (float) amount of claim - 'value': (str) value of claim - 'height' : (int) height of claim takeover - 'claim_id': (str) claim ID of claim - 'supports': (list) list of supports associated with claim - } +{ + "amount": (float) amount of claim + "claim_id": (str) claim ID of claim + "height" : (int) height of claim takeover + "nout": (int) nout of claim + "supports": (list) list of supports associated with claim + "txid": (str) txid of claim + "value": (str) value of claim +} - if claim cannot be resolved, dictionary as below will be returned +If claim cannot be resolved, dictionary as below will be returned - { - 'error': (str) reason for error - } +{ + "error": (str) reason for error +} ``` -### Arguments +Arguments: | Parameter | Description | |:------------|:-----------------------------------------------------------------| -| txid | (str) look for claim with this txid, nout must also be specified | -| nout | (int) look for claim with this nout, txid must also be specified | | claim_id | (str) look for claim with this claim id | +| nout | (int) look for claim with this nout, txid must also be specified | +| txid | (str) look for claim with this txid, nout must also be specified | ::: @@ -608,7 +600,7 @@ Returns: pos args ``` -### Arguments +Arguments: | Parameter | Description | |:-------------------|:--------------| @@ -634,11 +626,6 @@ Returns: ``` (list) list of available commands ``` - -### Arguments - -| Parameter | Description | -|| ::: @@ -653,13 +640,8 @@ Stop lbrynet-daemon. Returns: ``` - (string) Shutdown message +(string) Shutdown message ``` - -### Arguments - -| Parameter | Description | -|| ::: @@ -677,21 +659,22 @@ Returns: (bool) true if deletion was successful ``` -### Arguments +Arguments: -| Parameter | Description | |:-------------------------|:-------------------------------------------------------------------------------------------------------------------| -| delete_from_download_dir | (bool) delete file from download directory, instead of just deleting blobs | -| delete_all | (bool) if there are multiple matching files, allow the deletion of multiple files. Otherwise do not delete anything. | -| sd_hash | (str) delete by file sd hash | -| file_name | (str) delete by file name in downloads folder | -| stream_hash | (str) delete by file stream hash | -| rowid | (int) delete by file row id | -| claim_id | (str) delete by file claim id | -| txid | (str) delete by file claim txid | -| nout | (int) delete by file claim nout | -| claim_name | (str) delete by file claim name | -| channel_claim_id | (str) delete by file channel claim id | -| channel_name | (str) delete by file channel claim name | +| Parameter | Description | +|:-------------------------|:----------------------------------------------------------------------------------------------------------------------| +| channel_claim_id | (str) delete by file channel claim id | +| channel_name | (str) delete by file channel claim name | +| claim_id | (str) delete by file claim id | +| claim_name | (str) delete by file claim name | +| delete_all | (bool) if there are multiple matching files, allow the deletion of multiple files. Otherwise, do not delete anything. | +| delete_from_download_dir | (bool) delete file from download directory, instead of just deleting blobs | +| file_name | (str) delete by file name in downloads folder | +| nout | (int) delete by file claim nout | +| rowid | (int) delete by file row id | +| sd_hash | (str) delete by file sd hash | +| stream_hash | (str) delete by file stream hash | +| txid | (str) delete by file claim txid | ::: @@ -709,51 +692,51 @@ Returns: (list) List of files [{ - "completed": (bool) true if download is completed, - "file_name": (str) name of file, - "download_directory": (str) download directory, - "points_paid": (float) credit paid to download file, - "stopped": (bool) true if download is stopped, - "stream_hash": (str) stream hash of file, - "stream_name": (str) stream name , - "suggested_file_name": (str) suggested file name, - "sd_hash": (str) sd hash of file, - "download_path": (str) download path of file, - "mime_type": (str) mime type of file, - "key": (str) key attached to file, - "total_bytes": (int) file size in bytes, None if full_status is false, - "written_bytes": (int) written size in bytes, - "blobs_completed": (int) num_completed, None if full_status is false, - "blobs_in_stream": (int) None if full_status is false, - "status": (str) downloader status, None if full_status is false, - "claim_id": (str) None if full_status is false or if claim is not found, - "outpoint": (str) None if full_status is false or if claim is not found, - "txid": (str) None if full_status is false or if claim is not found, - "nout": (int) None if full_status is false or if claim is not found, - "metadata": (dict) None if full_status is false or if claim is not found, - "channel_claim_id": (str) None if full_status is false or if claim is not found or signed, - "channel_name": (str) None if full_status is false or if claim is not found or signed, + "blobs_completed": (int) num_completed, None if full_status is false + "blobs_in_stream": (int) None if full_status is false + "channel_claim_id": (str) None if full_status is false or if claim is not found or signed + "channel_name": (str) None if full_status is false or if claim is not found or signed + "claim_id": (str) None if full_status is false or if claim is not found "claim_name": (str) None if full_status is false or if claim is not found + "completed": (bool) true if download is completed + "download_directory": (str) download directory + "download_path": (str) download path of file + "file_name": (str) name of file + "key": (str) key attached to file + "metadata": (dict) None if full_status is false or if claim is not found + "mime_type": (str) mime type of file + "nout": (int) None if full_status is false or if claim is not found + "outpoint": (str) None if full_status is false or if claim is not found + "points_paid": (float) credit paid to download file + "sd_hash": (str) sd hash of file + "status": (str) downloader status, None if full_status is false + "stopped": (bool) true if download is stopped + "stream_hash": (str) stream hash of file + "stream_name": (str) stream name + "suggested_file_name": (str) suggested file name + "total_bytes": (int) file size in bytes, None if full_status is false + "txid": (str) None if full_status is false or if claim is not found + "written_bytes": (int) written size in bytes }] ``` -### Arguments +Arguments: | Parameter | Description | |:-----------------|:-----------------------------------------------------------------------------------------------------------------| -| sd_hash | (str) get file with matching sd hash | -| file_name | (str) get file with matching file name in the downloads folder | -| stream_hash | (str) get file with matching stream hash | -| rowid | (int) get file with matching row id | -| claim_id | (str) get file with matching claim id | -| outpoint | (str) get file with matching claim outpoint | -| txid | (str) get file with matching claim txid | -| nout | (int) get file with matching claim nout | | channel_claim_id | (str) get file with matching channel claim id | | channel_name | (str) get file with matching channel name | +| claim_id | (str) get file with matching claim id | | claim_name | (str) get file with matching claim name | -| full_status | (bool) full status, populate the 'message' and 'size' fields | -| sort | (str) sort by any property, like 'file_name' or 'metadata.author'; to specify direction append ',asc' or ',desc' | +| file_name | (str) get file with matching file name in the downloads folder | +| full_status | (bool) full status, populate the "message" and "size" fields | +| nout | (int) get file with matching claim nout | +| outpoint | (str) get file with matching claim outpoint | +| rowid | (int) get file with matching row id | +| sd_hash | (str) get file with matching sd hash | +| sort | (str) sort by any property, like "file_name" or "metadata.author"; to specify direction append ",asc" or ",desc" | +| stream_hash | (str) get file with matching stream hash | +| txid | (str) get file with matching claim txid | ::: @@ -771,15 +754,15 @@ Returns: (list) list of blobs reflected ``` -### Arguments +Arguments: | Parameter | Description | |:------------|:-------------------------------------------------------------------------------------| -| sd_hash | (str) get file with matching sd hash | | file_name | (str) get file with matching file name in the downloads folder | -| stream_hash | (str) get file with matching stream hash | -| rowid | (int) get file with matching row id | | reflector | (str) reflector server, ip address or url by default choose a server from the config | +| rowid | (int) get file with matching row id | +| sd_hash | (str) get file with matching sd hash | +| stream_hash | (str) get file with matching stream hash | ::: @@ -797,15 +780,15 @@ Returns: (str) Confirmation message ``` -### Arguments +Arguments: | Parameter | Description | |:------------------|:-------------------------------------------------------------------------| -| status *required* | (str) one of "start" or "stop" | -| sd_hash | (str) set status of file with matching sd hash | | file_name | (str) set status of file with matching file name in the downloads folder | -| stream_hash | (str) set status of file with matching stream hash | | rowid | (int) set status of file with matching row id | +| sd_hash | (str) set status of file with matching sd hash | +| status *required* | (str) one of "start" or "stop" | +| stream_hash | (str) set status of file with matching stream hash | ::: @@ -823,41 +806,41 @@ Returns: (dict) Dictionary containing information about the stream { - 'completed': (bool) true if download is completed, - 'file_name': (str) name of file, - 'download_directory': (str) download directory, - 'points_paid': (float) credit paid to download file, - 'stopped': (bool) true if download is stopped, - 'stream_hash': (str) stream hash of file, - 'stream_name': (str) stream name , - 'suggested_file_name': (str) suggested file name, - 'sd_hash': (str) sd hash of file, - 'download_path': (str) download path of file, - 'mime_type': (str) mime type of file, - 'key': (str) key attached to file, - 'total_bytes': (int) file size in bytes, None if full_status is false, - 'written_bytes': (int) written size in bytes, - 'blobs_completed': (int) num_completed, None if full_status is false, - 'blobs_in_stream': (int) None if full_status is false, - 'status': (str) downloader status, None if full_status is false, - 'claim_id': (str) claim id, - 'outpoint': (str) claim outpoint string, - 'txid': (str) claim txid, - 'nout': (int) claim nout, - 'metadata': (dict) claim metadata, - 'channel_claim_id': (str) None if claim is not signed - 'channel_name': (str) None if claim is not signed - 'claim_name': (str) claim name + "blobs_completed": (int) num_completed, None if `full_status` is false + "blobs_in_stream": (int) None if `full_status` is false + "channel_claim_id": (str) None if claim is not signed + "channel_name": (str) None if claim is not signed + "claim_id": (str) claim id + "claim_name": (str) claim name + "completed": (bool) true if download is completed + "download_directory": (str) download directory + "download_path": (str) download path of file + "key": (str) key attached to file + "file_name": (str) name of file + "metadata": (dict) claim metadata + "mime_type": (str) mime type of file + "nout": (int) claim nout + "outpoint": (str) claim outpoint string + "points_paid": (float) credit paid to download file + "sd_hash": (str) sd hash of file + "status": (str) downloader status, None if `full_status` is false + "stopped": (bool) true if download is stopped + "stream_hash": (str) stream hash of file + "stream_name": (str) stream name + "suggested_file_name": (str) suggested file name + "total_bytes": (int) file size in bytes, None if `full_status` is false + "txid": (str) claim txid + "written_bytes": (int) written size in bytes } ``` -### Arguments +Arguments: | Parameter | Description | |:------------|:---------------------------------------------| -| uri | (str) uri of the content to download | | file_name | (str) specified name for the downloaded file | | timeout | (int) download timeout in number of seconds | +| uri | (str) uri of the content to download | ::: @@ -875,7 +858,7 @@ Returns: (str) Help message ``` -### Arguments +Arguments: | Parameter | Description | |:------------|:--------------------------------------------| @@ -894,10 +877,10 @@ Get peers for blob hash. Returns: ``` -(list) List of contact dictionaries {'host': , 'port': , 'node_id': } +(list) List of contact dictionaries { "host": , "port": , "node_id": } ``` -### Arguments +Arguments: | Parameter | Description | |:---------------------|:----------------------------------------------| @@ -917,13 +900,8 @@ Find and ping a peer by node id. Returns: ``` -(str) pong, or {'error': } if an error is encountered +(str) pong, or {"error": } if an error is encountered ``` - -### Arguments - -| Parameter | Description | -|| ::: @@ -951,36 +929,36 @@ Returns: (dict) Dictionary containing result of the claim { - 'tx' : (str) hex encoded transaction - 'txid' : (str) txid of resulting claim - 'nout' : (int) nout of the resulting claim - 'fee' : (decimal) fee paid for the claim transaction - 'claim_id' : (str) claim ID of the resulting claim + "claim_id": (str) claim ID of the resulting claim + "fee": (decimal) fee paid for the claim transaction + "nout": (int) nout of the resulting claim + "tx": (str) hex encoded transaction + "txid": (str) txid of resulting claim } ``` -### Arguments +Arguments: -| Parameter | Description | -|:----------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| name *required* | (str) name of the content | -| bid *required* | (decimal) amount to back the claim | -| metadata | (dict) ClaimDict to associate with the claim. | -| file_path | (str) path to file to be associated with name. If provided, a lbry stream of this file will be used in 'sources'. If no path is given but a sources dict is provided, it will be used. If neither are provided, an error is raised. | -| fee | (dict) Dictionary representing key fee to download content:{'currency': currency_symbol,'amount': decimal,'address': str, optional}supported currencies: LBC, USD, BTCIf an address is not provided a new one will be automatically generated. Default fee is zero. | -| title | (str) title of the publication | -| description | (str) description of the publication | -| author | (str) author of the publication | -| language | (str) language of the publication | -| license | (str) publication license | -| license_url | (str) publication license url | -| thumbnail | (str) thumbnail url | -| preview | (str) preview url | -| nsfw | (bool) title of the publication | -| sources | (str) {'lbry_sd_hash': sd_hash} specifies sd hash of file | -| channel_name | (str) name of the publisher channel name in the wallet | -| channel_id | (str) claim id of the publisher channel, does not check for channel claim being in the wallet. This allows publishing to a channel where only the certificate private key is in the wallet. | -| claim_address | (str) address where the claim is sent to, if not specified new address will automatically be created | +| Parameter | Description | +|:----------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| author | (str) author of the publication | +| bid *required* | (decimal) amount to back the claim | +| channel_name | (str) name of the publisher channel name in the wallet | +| channel_id | (str) claim id of the publisher channel, does not check for channel claim being in the wallet. This allows publishing to a channel where only the certificate private key is in the wallet. | +| claim_address | (str) address where the claim is sent to, if not specified new address will automatically be created | +| description | (str) description of the publication | +| fee | (dict) Dictionary representing key fee to download content: {"currency": currency_symbol, "amount": decimal, "address": str, optional } supported currencies: LBC, USD, BTCIf an address is not provided a new one will be automatically generated. Default fee is zero. | +| file_path | (str) path to file to be associated with name. If provided, a lbry stream of this file will be used in "sources". If no path is given but a sources dict is provided, it will be used. If neither are provided, an error is raised. | +| language | (str) language of the publication | +| license | (str) publication license | +| license_url | (str) publication license url | +| metadata | (dict) ClaimDict to associate with the claim. | +| name *required* | (str) name of the content | +| nsfw | (bool) title of the publication | +| preview | (str) preview url | +| sources | (str) { "lbry_sd_hash": sd_hash } specifies sd hash of file | +| thumbnail | (str) thumbnail url | +| title | (str) title of the publication | ::: @@ -998,7 +976,7 @@ Returns: (bool) true if successful ``` -### Arguments +Arguments: | Parameter | Description | |:-------------------|:-----------------------------| @@ -1019,65 +997,65 @@ Returns: ``` Dictionary of results, keyed by uri -'': { +"": { If a resolution error occurs: - 'error': Error message + "error": Error message If the uri resolves to a channel or a claim in a channel: - 'certificate': { - 'address': (str) claim address, - 'amount': (float) claim amount, - 'effective_amount': (float) claim amount including supports, - 'claim_id': (str) claim id, - 'claim_sequence': (int) claim sequence number, - 'decoded_claim': (bool) whether or not the claim value was decoded, - 'height': (int) claim height, - 'depth': (int) claim depth, - 'has_signature': (bool) included if decoded_claim - 'name': (str) claim name, - 'permanent_url': (str) permanent url of the certificate claim, - 'supports: (list) list of supports [{ - 'txid': (str) txid, - 'nout': (int) nout, - 'amount': (float) amount - }], - 'txid': (str) claim txid, - 'nout': (str) claim nout, - 'signature_is_valid': (bool), included if has_signature, - 'value': ClaimDict if decoded, otherwise hex string + "certificate": { + "address": (str) claim address + "amount": (float) claim amount + "claim_id": (str) claim id + "claim_sequence": (int) claim sequence number + "decoded_claim": (bool) whether or not the claim value was decoded + "depth": (int) claim depth + "effective_amount": (float) claim amount including supports + "has_signature": (bool) included if decoded_claim + "height": (int) claim height + "name": (str) claim name + "nout": (str) claim nout + "permanent_url": (str) permanent url of the certificate claim + "signature_is_valid": (bool), included if has_signature + "supports: (list) list of supports [{ + "amount": (float) amount + "nout": (int) nout + "txid": (str) txid + }] + "txid": (str) claim txid + "value": ClaimDict if decoded, otherwise hex string } If the uri resolves to a channel: - 'claims_in_channel': (int) number of claims in the channel, + "claims_in_channel": (int) number of claims in the channel, If the uri resolves to a claim: - 'claim': { - 'address': (str) claim address, - 'amount': (float) claim amount, - 'effective_amount': (float) claim amount including supports, - 'claim_id': (str) claim id, - 'claim_sequence': (int) claim sequence number, - 'decoded_claim': (bool) whether or not the claim value was decoded, - 'height': (int) claim height, - 'depth': (int) claim depth, - 'has_signature': (bool) included if decoded_claim - 'name': (str) claim name, - 'permanent_url': (str) permanent url of the claim, - 'channel_name': (str) channel name if claim is in a channel - 'supports: (list) list of supports [{ - 'txid': (str) txid, - 'nout': (int) nout, - 'amount': (float) amount - }], - 'txid': (str) claim txid, - 'nout': (str) claim nout, - 'signature_is_valid': (bool), included if has_signature, - 'value': ClaimDict if decoded, otherwise hex string + "claim": { + "address": (str) claim address + "amount": (float) claim amount + "channel_name": (str) channel name if claim is in a channel + "claim_id": (str) claim id + "claim_sequence": (int) claim sequence number + "decoded_claim": (bool) whether or not the claim value was decoded + "depth": (int) claim depth + "effective_amount": (float) claim amount including supports + "has_signature": (bool) included if decoded_claim + "height": (int) claim height + "name": (str) claim name + "nout": (str) claim nout + "permanent_url": (str) permanent url of the claim + "signature_is_valid": (bool), included if has_signature + "supports: (list) list of supports [{ + "amount": (float) amount + "nout": (int) nout + "txid": (str) txid + }] + "txid": (str) claim txid + "value": ClaimDict if decoded, otherwise hex string } } ``` -### Arguments +Arguments: | Parameter | Description | |:---------------|:--------------------------------------| @@ -1101,12 +1079,12 @@ Returns: (dict) Metadata dictionary from name claim, None if the name is not resolvable ``` -### Arguments +Arguments: | Parameter | Description | |:----------------|:--------------------------------------------| -| name *required* | (str) the name to resolve | | force | (bool) force refresh and do not check cache | +| name *required* | (str) the name to resolve | ::: @@ -1125,25 +1103,18 @@ Returns: { "buckets": { - : [ - { - "address": (str) peer address, - "port": (int) peer udp port - "node_id": (str) peer node id, - "blobs": (list) blob hashes announced by peer - } - ] - }, - "contacts": (list) contact node ids, - "blob_hashes": (list) all of the blob hashes stored by peers in the list of buckets, + : [{ + "address": (str) peer address + "blobs": (list) blob hashes announced by peer + "node_id": (str) peer node id + "port": (int) peer udp port + }] + } + "blob_hashes": (list) all of the blob hashes stored by peers in the list of buckets + "contacts": (list) contact node ids "node_id": (str) the local dht node id } ``` - -### Arguments - -| Parameter | Description | -|| ::: @@ -1161,11 +1132,6 @@ Returns: (dict) Dictionary of daemon settings See ADJUSTABLE_SETTINGS in lbrynet/conf.py for full list of settings ``` - -### Arguments - -| Parameter | Description | -|| ::: @@ -1183,24 +1149,24 @@ Returns: (dict) Updated dictionary of daemon settings ``` -### Arguments +Arguments: -| Parameter | Description | -|:------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| download_directory | (str) path of download directory | -| data_rate | (float) 0.0001 | -| download_timeout | (int) 180 | -| peer_port | (int) 3333 | -| max_key_fee | (dict) maximum key fee for downloads, in the format: {'currency': ,'amount': }. In the CLI, it must be an escaped JSON stringSupported currency symbols: LBC, USD, BTC | -| disable_max_key_fee | (bool) False | -| use_upnp | (bool) True | -| run_reflector_server | (bool) False | -| cache_time | (int) 150 | -| reflect_uploads | (bool) True | -| share_usage_data | (bool) True | -| peer_search_timeout | (int) 3 | -| sd_download_timeout | (int) 3 | -| auto_renew_claim_height_delta | (int) 0 claims set to expire within this many blocks will be automatically renewed after startup (if set to 0, renews will not be made automatically) | +| Parameter | Description | +|:------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| auto_renew_claim_height_delta | (int) 0 claims set to expire within this many blocks will be automatically renewed after startup (if set to 0, renews will not be made automatically) | +| cache_time | (int) 150 | +| data_rate | (float) 0.0001 | +| disable_max_key_fee | (bool) False | +| download_directory | (str) path of download directory | +| download_timeout | (int) 180 | +| max_key_fee | (dict) maximum key fee for downloads, in the format: { "currency": , "amount": }. In the CLI, it must be an escaped JSON stringSupported currency symbols: LBC, USD, BTC | +| peer_port | (int) 3333 | +| peer_search_timeout | (int) 3 | +| reflect_uploads | (bool) True | +| run_reflector_server | (bool) False | +| sd_download_timeout | (int) 3 | +| share_usage_data | (bool) True | +| use_upnp | (bool) True | ::: @@ -1218,37 +1184,37 @@ Returns: (dict) lbrynet-daemon status { - 'lbry_id': lbry peer id, base58, - 'installation_id': installation id, base58, - 'is_running': bool, - 'is_first_run': bool, - 'startup_status': { - 'code': status code, - 'message': status message - }, - 'connection_status': { - 'code': connection status code, - 'message': connection status message - }, - 'blockchain_status': { - 'blocks': local blockchain height, - 'blocks_behind': remote_height - local_height, - 'best_blockhash': block hash of most recent block - }, - 'wallet_is_encrypted': bool, + "blockchain_status": { + "best_blockhash": block hash of most recent block + "blocks": local blockchain height + "blocks_behind": remote_height - local_height + } + "connection_status": { + "code": connection status code, + "message": connection status message + } + "installation_id": installation id, base58 + "is_first_run": bool + "is_running": bool + "lbry_id": lbry peer id, base58 + "startup_status": { + "code": status code, + "message": status message + } + "wallet_is_encrypted": bool If given the session status option: - 'session_status': { - 'managed_blobs': count of blobs in the blob manager, - 'managed_streams': count of streams in the file manager - 'announce_queue_size': number of blobs currently queued to be announced - 'should_announce_blobs': number of blobs that should be announced + "session_status": { + "announce_queue_size": number of blobs currently queued to be announced + "managed_blobs": count of blobs in the blob manager + "managed_streams": count of streams in the file manager + "should_announce_blobs": number of blobs that should be announced } } ``` -### Arguments +Arguments: | Parameter | Description | |:---------------|:-----------------------------------------| @@ -1268,28 +1234,28 @@ Returns: ``` (dict) { - 'is_available': , - 'did_decode': , - 'did_resolve': , - 'is_stream': , - 'num_blobs_in_stream': , - 'sd_hash': , - 'sd_blob_availability': see `blob_availability`, - 'head_blob_hash': , - 'head_blob_availability': see `blob_availability`, - 'use_upnp': , - 'upnp_redirect_is_set': , - 'error': | error message + "did_decode": + "did_resolve": + "error": | error message + "head_blob_availability": see `blob_availability` + "head_blob_hash": + "is_available": + "is_stream": + "num_blobs_in_stream": + "sd_blob_availability": see `blob_availability` + "sd_hash": + "upnp_redirect_is_set": + "use_upnp": } ``` -### Arguments +Arguments: | Parameter | Description | |:---------------|:-----------------------------------------------------------| -| uri *required* | (str) check availability for this uri | -| search_timeout | (int) how long to search for peers for the blob in the dht | | blob_timeout | (int) how long to try downloading from a peer | +| search_timeout | (int) how long to search for peers for the blob in the dht | +| uri *required* | (str) check availability for this uri | ::: @@ -1307,12 +1273,12 @@ Returns: (float) Estimated cost in lbry credits, returns None if uri is not resolvable ``` -### Arguments +Arguments: | Parameter | Description | |:---------------|:--------------------------------------------------------------------------| -| uri *required* | (str) uri to use | | size | (float) stream size in bytes. If provided an sd blob won't be downloaded. | +| uri *required* | (str) uri to use | ::: @@ -1330,52 +1296,47 @@ Returns: (list) List of transactions { - "claim_info": (list) claim info if in txn [{ - "address": (str) address of claim, - "balance_delta": (float) bid amount, - "amount": (float) claim amount, - "claim_id": (str) claim id, - "claim_name": (str) claim name, - "nout": (int) nout - }], "abandon_info": (list) abandon info if in txn [{ - "address": (str) address of abandoned claim, - "balance_delta": (float) returned amount, - "amount": (float) claim amount, - "claim_id": (str) claim id, - "claim_name": (str) claim name, + "address": (str) address of abandoned claim + "amount": (float) claim amount + "balance_delta": (float) returned amount + "claim_id": (str) claim id + "claim_name": (str) claim name "nout": (int) nout - }], - "confirmations": (int) number of confirmations for the txn, - "date": (str) date and time of txn, - "fee": (float) txn fee, + }] + "claim_info": (list) claim info if in txn [{ + "address": (str) address of claim + "amount": (float) claim amount + "balance_delta": (float) bid amount + "claim_id": (str) claim id + "claim_name": (str) claim name + "nout": (int) nout + }] + "confirmations": (int) number of confirmations for the txn + "date": (str) date and time of txn + "fee": (float) txn fee "support_info": (list) support info if in txn [{ - "address": (str) address of support, - "balance_delta": (float) support amount, - "amount": (float) support amount, - "claim_id": (str) claim id, - "claim_name": (str) claim name, - "is_tip": (bool), + "address": (str) address of support + "amount": (float) support amount + "balance_delta": (float) support amount + "claim_id": (str) claim id + "claim_name": (str) claim name + "is_tip": (bool) "nout": (int) nout - }], - "timestamp": (int) timestamp, - "txid": (str) txn id, + }] + "timestamp": (int) timestamp + "txid": (str) txn id "update_info": (list) update info if in txn [{ - "address": (str) address of claim, + "address": (str) address of claim + "amount": (float) absolute amount "balance_delta": (float) credited/debited - "amount": (float) absolute amount, - "claim_id": (str) claim id, - "claim_name": (str) claim name, + "claim_id": (str) claim id + "claim_name": (str) claim name "nout": (int) nout - }], + }] "value": (float) value of txn } ``` - -### Arguments - -| Parameter | Description | -|| ::: @@ -1393,7 +1354,7 @@ Returns: (dict) JSON formatted transaction ``` -### Arguments +Arguments: | Parameter | Description | |:----------------|:------------------------------| @@ -1425,15 +1386,10 @@ Returns: "is_update": (bool) is the tx an update "nout": (int) nout of the output "txid": (str) txid of the output - }, + } ... ] ``` - -### Arguments - -| Parameter | Description | -|| ::: @@ -1451,23 +1407,18 @@ Returns: (dict) Dictionary of lbry version information { - 'build': (str) build type (e.g. "dev", "rc", "release"), - 'ip': (str) remote ip, if available, - 'lbrynet_version': (str) lbrynet_version, - 'lbryum_version': (str) lbryum_version, - 'lbryschema_version': (str) lbryschema_version, - 'os_release': (str) os release string - 'os_system': (str) os name - 'platform': (str) platform string - 'processor': (str) processor type, - 'python_version': (str) python version + "build": (str) build type (e.g. "dev", "rc", "release") + "ip": (str) remote ip, if available + "lbrynet_version": (str) lbrynet_version + "lbryschema_version": (str) lbryschema_version + "lbryum_version": (str) lbryum_version + "os_release": (str) os release string + "os_system": (str) os name + "platform": (str) platform string + "processor": (str) processor type + "python_version": (str) python version } ``` - -### Arguments - -| Parameter | Description | -|| ::: @@ -1485,7 +1436,7 @@ Returns: (float) amount of lbry credits in wallet ``` -### Arguments +Arguments: | Parameter | Description | |:--------------------|:------------------------------------------------------------------| @@ -1507,11 +1458,6 @@ Returns: ``` (bool) true if wallet is decrypted, otherwise false ``` - -### Arguments - -| Parameter | Description | -|| ::: @@ -1530,7 +1476,7 @@ Returns: (bool) true if wallet is decrypted, otherwise false ``` -### Arguments +Arguments: | Parameter | Description | |:------------------------|:-------------------------------------------------------| @@ -1552,7 +1498,7 @@ Returns: (bool) true, if address is associated with current wallet ``` -### Arguments +Arguments: | Parameter | Description | |:-------------------|:-----------------------| @@ -1573,11 +1519,6 @@ Returns: ``` List of wallet addresses ``` - -### Arguments - -| Parameter | Description | -|| ::: @@ -1594,11 +1535,6 @@ Returns: ``` (str) New wallet address in base58 ``` - -### Arguments - -| Parameter | Description | -|| ::: @@ -1616,13 +1552,13 @@ Returns: (dict) the resulting transaction ``` -### Arguments +Arguments: | Parameter | Description | |:-------------------------|:---------------------------------------| +| amount *required* | (float) initial amount in each address | | no_broadcast | (bool) whether to broadcast or not | | num_addresses *required* | (int) num of addresses to create | -| amount *required* | (float) initial amount in each address | ::: @@ -1640,7 +1576,7 @@ Returns: (list) list of public keys associated with address. Could contain more than one public key if multisig. ``` -### Arguments +Arguments: | Parameter | Description | |:-------------------|:----------------------------------------------| @@ -1664,20 +1600,21 @@ If sending to an address: If sending a claim tip: (dict) Dictionary containing the result of the support + { - txid : (str) txid of resulting support claim - nout : (int) nout of the resulting support claim - fee : (float) fee paid for the transaction + "fee": (float) fee paid for the transaction + "nout": (int) nout of the resulting support claim + "txid": (str) txid of resulting support claim } ``` -### Arguments +Arguments: -| Parameter | Description | -|:--------------------|:------------------------------------------------| -| amount *required* | (float) amount of credit to send | -| address *required* | (str) address to send credits to | -| claim_id *required* | (float) claim_id of the claim to send to tip to | +| Parameter | Description | +|:--------------------|:------------------------------------------| +| address *required* | (str) address to send credits to | +| amount *required* | (float) amount of credit to send | +| claim_id *required* | (float) claim id of the claim to send tip | ::: @@ -1695,7 +1632,7 @@ Returns: (bool) true if wallet is unlocked, otherwise false ``` -### Arguments +Arguments: | Parameter | Description | |:--------------------|:------------------------------------| @@ -1716,9 +1653,4 @@ Returns: ``` (str) Unused wallet address in base58 ``` - -### Arguments - -| Parameter | Description | -|| ::: diff --git a/content/.vuepress/scss/partials/_slate_icons.scss b/content/.vuepress/scss/partials/_slate_icons.scss deleted file mode 100644 index 24fd9a3..0000000 --- a/content/.vuepress/scss/partials/_slate_icons.scss +++ /dev/null @@ -1,38 +0,0 @@ -@font-face { - font-family: FontAwesome; - font-style: normal; - font-weight: normal; - src: url($font-icon-path+".eot?v=#"+$font-icon-version); - src: url($font-icon-path+".eot?#iefix&v=#"+$font-icon-version) format("embedded-opentype"), url($font-icon-path+".woff?v=#"+$font-icon-version) format("woff"), url($font-icon-path+".ttf?v=#"+$font-icon-version) format("truetype"), url($font-icon-path+".svg#fontawesomeregular?v=#"+$font-icon-version) format("svg");; -} - -%icon { - font-family: 'FontAwesome'; - speak: none; - font-style: normal; - font-weight: normal; - font-variant: normal; - text-transform: none; - line-height: 1; -} - -%icon-exclamation-sign { - @extend %icon; - content: "\f06a"; -} - -%icon-info-sign { - @extend %icon; - content: "\f05a"; -} - -%icon-ok-sign { - @extend %icon; - content: "\f058"; -} - -%icon-search { - @extend %icon; - content: "\f002"; -} - diff --git a/content/.vuepress/scss/partials/_slate_style.scss b/content/.vuepress/scss/partials/_slate_style.scss deleted file mode 100644 index 77f5b18..0000000 --- a/content/.vuepress/scss/partials/_slate_style.scss +++ /dev/null @@ -1,523 +0,0 @@ -/* -Copyright 2008-2013 Concur Technologies, Inc. - -Licensed under the Apache License, Version 2.0 (the "License"); you may -not use this file except in compliance with the License. You may obtain -a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, WITHOUT -WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the -License for the specific language governing permissions and limitations -under the License. -*/ -.slate { - color: $main-text; - padding: 0; - margin: 0; - -webkit-font-smoothing: antialiased; - -moz-osx-font-smoothing: grayscale; - @extend %default-font; - background-color: $main-bg; - height: 100%; - -webkit-text-size-adjust: none; - /* Never autoresize text */ - #toc > ul > li > a > span { - float: right; - background-color: #2484FF; - border-radius: 40px; - width: 20px; - } - @mixin embossed-bg() { - background: linear-gradient(to bottom, rgba(black, 0.2), rgba(black, 0) 8px), linear-gradient(to top, rgba(black, 0.2), rgba(black, 0) 8px), linear-gradient(to bottom, rgba($nav-embossed-border-top, 1), rgba($nav-embossed-border-top, 0) 1.5px), linear-gradient(to top, rgba($nav-embossed-border-bottom, 1), rgba($nav-embossed-border-bottom, 0) 1.5px), $nav-subitem-bg; - } - .tocify-wrapper { - transition: left 0.3s ease-in-out; - overflow-y: auto; - overflow-x: hidden; - position: fixed; - z-index: 30; - top: 64px; - left: 0; - bottom: 0; - width: $nav-width; - background-color: $nav-bg; - font-size: 13px; - font-weight: bold; - .lang-selector { - display: none; - a { - padding-top: 0.5em; - padding-bottom: 0.5em; - } - } - & > img { - display: block; - } - & > .search { - position: relative; - input { - background: $nav-bg; - border-width: 0 0 1px 0; - border-color: $search-box-border-color; - padding: 6px 0 6px 20px; - box-sizing: border-box; - margin: $nav-v-padding $nav-padding; - width: $nav-width - 30; - outline: none; - color: $nav-text; - border-radius: 0; - /* ios has a default border radius */ - } - &:before { - position: absolute; - top: 17px; - left: $nav-padding; - color: $nav-text; - @extend %icon-search; - } - } - img+.tocify { - margin-top: $logo-margin; - } - .search-results { - margin-top: 0; - box-sizing: border-box; - height: 0; - overflow-y: auto; - overflow-x: hidden; - transition-property: border-box, border-box; - transition-duration: 180ms; - transition-timing-function: ease-in-out; - &.visible { - height: 30%; - margin-bottom: 1em; - } - @include embossed-bg(); - li { - margin: 1em $nav-padding; - line-height: 1; - } - a { - color: $nav-text; - text-decoration: none; - &:hover { - text-decoration: underline; - } - } - } - .tocify-item>a, .toc-footer li { - padding: 0 $nav-padding 0 $nav-padding; - display: block; - overflow-x: hidden; - white-space: nowrap; - text-overflow: ellipsis; - } - ul, li { - list-style: none; - margin: 0; - padding: 0; - line-height: 28px; - } - li { - color: $nav-text; - transition-property: relative; - transition-timing-function: linear; - transition-duration: 230ms; - } - .tocify-focus { - box-shadow: 0px 1px 0px $nav-active-shadow; - background-color: $nav-active-bg; - color: $nav-active-text; - } - .tocify-subheader { - display: none; - - background-color: $nav-subitem-bg; - font-weight: 500; - .tocify-item>a { - padding-left: $nav-padding + $nav-indent; - font-size: 12px; - } - @include embossed-bg(); - & > li:last-child { - box-shadow: none; - } - .tocify-subheader { - display: none; - - background-color: $nav-subitem-bg; - font-weight: 500; - .tocify-item>a { - padding-left: $nav-padding + $nav-indent + $nav-indent * 3; - font-size: 12px; - @include embossed-bg(); - & > li:last-child { - box-shadow: none; - } - } - .tocify-subheader { - display: none; - - background-color: $nav-subitem-bg; - font-weight: 500; - .tocify-item>a { - padding-left: $nav-padding + $nav-indent + $nav-indent * 5; - font-size: 12px; - @include embossed-bg(); - & > li:last-child { - box-shadow: none; - } - } - } - } - } - .toc-footer { - padding: 1em 0; - margin-top: 1em; - border-top: 1px dashed $nav-footer-border-color; - li, a { - color: $nav-text; - text-decoration: none; - } - a:hover { - text-decoration: underline; - } - li { - font-size: 0.8em; - line-height: 1.7; - text-decoration: none; - } - } - } - #nav-button { - span { - display: block; - $side-pad: $main-padding / 2 - 8px; - padding: $side-pad $side-pad $side-pad; - background-color: rgba($main-bg, 0.7); - transform-origin: 0 0; - transform: rotate(-90deg) translate(-100%, 0); - border-radius: 0 0 0 5px; - } - padding: 0 1.5em 5em 0; - - display: none; - position: fixed; - top: 64px; - left: 0; - z-index: 100; - color: #000; - text-decoration: none; - font-weight: bold; - opacity: 0.7; - line-height: 16px; - img { - height: 16px; - vertical-align: 0; - } - transition: 0 0.3s ease-in-out; - &:hover { - opacity: 1; - } - &.open { - left: $nav-width; - } - } - .page-wrapper { - margin-left: $nav-width; - position: relative; - z-index: 10; - background-color: $main-bg; - min-height: 100%; - padding-bottom: 1px; - .dark-box { - width: $examples-width; - background-color: $examples-bg; - position: absolute; - right: 0; - top: 0; - bottom: 0; - } - .lang-selector { - position: fixed; - z-index: 50; - border-bottom: 5px solid $lang-select-active-bg; - } - } - .lang-selector { - background-color: $lang-select-bg; - width: 100%; - font-weight: bold; - a { - display: block; - float: 1; - color: $lang-select-text; - text-decoration: none; - padding: 0 10px; - line-height: 30px; - outline: 0; - &:active, &:focus { - background-color: $lang-select-pressed-bg; - color: $lang-select-pressed-text; - } - &.active { - background-color: $lang-select-active-bg; - color: $lang-select-active-text; - } - } - &:after { - content: ''; - clear: both; - display: block; - } - } - .content { - - position: relative; - z-index: 30; - &:after { - content: ''; - display: block; - clear: both; - } - & > h1, & > h2, & > h3, & > h4, & > h5, & > h6, & > p, & > table, & > ul, & > ol, & > aside, & > dl { - margin-right: $examples-width; - padding: 0 $main-padding; - box-sizing: border-box; - display: block; - text-shadow: $main-embossed-text-shadow; - } - & > ul, & > ol { - padding-left: $main-padding + 15px; - } - & > h1, & > h2, & > div { - clear: both; - } - h1 { - @extend %header-font; - font-size: 30px; - padding-top: 0.5em; - padding-bottom: 0.5em; - border-bottom: 1px solid #ccc; - margin-bottom: $h1-margin-bottom; - margin-top: 2em; - border-top: 1px solid #ddd; - background-image: linear-gradient(to bottom, white, #f9f9f9); - } - h1:first-child, div:first-child + h1 { - border-top-width: 0; - margin-top: 0; - } - h2 { - @extend %header-font; - font-size: 20px; - margin-top: 4em; - margin-bottom: 0; - border-top: 1px solid #ccc; - padding-top: 1.2em; - padding-bottom: 1.2em; - background-image: linear-gradient(to bottom, rgba(white, 0.4), rgba(white, 0)); - } - h1 + h2, h1 + div + h2 { - margin-top: $h1-margin-bottom * -1; - border-top: none; - } - h3, h4, h5, h6 { - @extend %header-font; - font-size: 15px; - margin-top: 2.5em; - margin-bottom: 0.8em; - } - h4, h5, h6 { - font-size: 10px; - } - hr { - margin: 2em 0; - border-top: 2px solid $examples-bg; - border-bottom: 2px solid $main-bg; - } - table { - margin-bottom: 1em; - overflow: auto; - width: auto; - th, td { - text-align: 1; - vertical-align: 0; - line-height: 1.6; - &:nth-of-type(1) { - text-align: right !important; - font-weight: bold; - } - em { - display: block; - text-transform: uppercase; - color: #e69731; - font-size: 0.75rem; - font-style: normal; - } - } - th { - padding: 5px 10px; - border-bottom: 1px solid #ccc; - vertical-align: 0; - } - td { - padding: 10px; - } - tr:last-child { - border-bottom: 1px solid #ccc; - } - tr:nth-child(odd) > td { - background-color: lighten($main-bg, 4.2%); - } - tr:nth-child(even) > td { - background-color: lighten($main-bg, 2.4%); - } - } - dt { - font-weight: bold; - } - dd { - margin-left: 15px; - } - p, li, dt, dd { - line-height: 1.6; - margin-top: 0; - } - img { - max-width: 100%; - } - code { - background-color: rgba(0, 0, 0, 0.05); - padding: 3px; - border-radius: 3px; - @extend %break-words; - @extend %code-font; - } - pre>code { - background-color: transparent; - padding: 0; - } - aside { - padding-top: 1em; - padding-bottom: 1em; - text-shadow: 0 1px 0 lighten($aside-notice-bg, 15%); - margin-top: 1.5em; - margin-bottom: 1.5em; - background: $aside-notice-bg; - line-height: 1.6; - &.warning { - background-color: $aside-warning-bg; - text-shadow: 0 1px 0 lighten($aside-warning-bg, 15%); - } - &.success { - background-color: $aside-success-bg; - text-shadow: 0 1px 0 lighten($aside-success-bg, 15%); - } - } - aside:before { - vertical-align: middle; - padding-right: 0.5em; - font-size: 14px; - } - aside.notice:before { - @extend %icon-info-sign; - } - aside.warning:before { - @extend %icon-exclamation-sign; - } - aside.success:before { - @extend %icon-ok-sign; - } - .search-highlight { - padding: 2px; - margin: -2px; - border-radius: 4px; - border: 1px solid #F7E633; - text-shadow: 1px 1px 0 #666666; - background: linear-gradient(to top left, #f7e633 0%, #f1d32f 100%); - } - } - .content { - pre, blockquote { - background-color: $code-bg; - color: #fff; - padding: 2em $main-padding; - margin: 0; - width: $examples-width; - float: right; - clear: right; - box-sizing: border-box; - text-shadow: 0px 1px 2px rgba(0, 0, 0, 0.4); - & > p { - margin: 0; - } - a { - color: #fff; - text-decoration: none; - border-bottom: dashed 1px #ccc; - } - } - pre { - @extend %code-font; - } - blockquote { - & > p { - background-color: $code-annotation-bg; - border-radius: 5px; - padding: $code-annotation-padding; - color: #ccc; - border-top: 1px solid #000; - border-bottom: 1px solid #404040; - } - } - } - - - - - - @media (max-width: $tablet-width) { - .tocify-wrapper { - left: -1 * $nav-width; - &.open { - left: 0; - } - } - .page-wrapper { - margin-left: 0; - } - #nav-button { - display: block; - } - .tocify-wrapper .tocify-item > a { - padding-top: 0.3em; - padding-bottom: 0.3em; - } - } - @media (max-width: $phone-width) { - .dark-box { - display: none; - } - .tocify-wrapper .lang-selector { - display: block; - } - .page-wrapper .lang-selector { - display: none; - } - .content { - h1, h2, h3, h4, h5, h6, p, table, ul, ol, aside, dl { - margin-right: 0; - } - - pre, blockquote { - float: none; - width: auto; - } - } - } - -} \ No newline at end of file diff --git a/content/.vuepress/scss/partials/_slate_variables.scss b/content/.vuepress/scss/partials/_slate_variables.scss deleted file mode 100644 index 1645d43..0000000 --- a/content/.vuepress/scss/partials/_slate_variables.scss +++ /dev/null @@ -1,146 +0,0 @@ -/* -Copyright 2008-2013 Concur Technologies, Inc. - -Licensed under the Apache License, Version 2.0 (the "License"); you may -not use this file except in compliance with the License. You may obtain -a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, WITHOUT -WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the -License for the specific language governing permissions and limitations -under the License. -*/ - -//////////////////////////////////////////////////////////////////////////////// -// CUSTOMIZE WHITEBOARD -// -// Use these settings to help adjust the appearance of Whiteboard -//////////////////////////////////////////////////////////////////////////////// - -//////////////////// -// BACKGROUND COLORS -//////////////////// -$nav-bg: #393939; -$examples-bg: #393939; -$code-bg: #292929; -$code-annotation-bg: #1c1c1c; -$nav-subitem-bg: #262626; -$nav-active-bg: #2467af; -$lang-select-border: black; -$lang-select-bg: #222222; - -// feel free to change this to blue or something -$lang-select-active-bg: $examples-bg; - -// color of language tab bg when mouse is pressed -$lang-select-pressed-bg: #111111; - -$main-bg: #eaf2f6; -$aside-notice-bg: #8fbcd4; -$aside-warning-bg: #c97a7e; -$aside-success-bg: #6ac174; -$search-notice-bg: #c97a7e; - -//////////////////// -// TEXT COLORS -//////////////////// - -// main content text color -$main-text: #333333; - -// color of unselected language tab text -$nav-text: white; -$nav-active-text: white; -$lang-select-text: white; - -// color of selected language tab text -$lang-select-active-text: white; - -// color of language tab text when mouse is pressed -$lang-select-pressed-text: white; - -//////////////////// -// SIZES -//////////////////// - -// width of the navbar -$nav-width: 230px; - -// portion of the screen taken up by code examples -$examples-width: 50%; - -// margin between nav items and logo, ignored if search is active -$logo-margin: 20px; - -// padding to left and right of content & examples -$main-padding: 28px; - -// padding to left and right of navbar -$nav-padding: 15px; - -// padding used vertically around search boxes and results -$nav-v-padding: 10px; - -// extra padding for ToC subitems -$nav-indent: 10px; - -// padding inside code annotations -$code-annotation-padding: 13px; - -// padding under the largest header tags -$h1-margin-bottom: 21px; - -// min width before reverting to tablet size -$tablet-width: 930px; - -// min width before reverting to mobile size -$phone-width: $tablet-width - $nav-width; - -//////////////////// -// FONTS -//////////////////// - -%default-font { - font-family: "Helvetica Neue", Helvetica, Arial, "Microsoft Yahei","微软雅黑", STXihei, "华文细黑", sans-serif; - font-size: 13px; -} - -%header-font { - @extend %default-font; - font-weight: bold; -} - -%code-font { - font-family: Consolas, Menlo, Monaco, "Lucida Console", "Liberation Mono", "DejaVu Sans Mono", "Bitstream Vera Sans Mono", "Courier New", monospace, serif; - font-size: 12px; - line-height: 1.5; -} - -$font-icon: FontAwesome; -$font-icon-path: "../public/fonts/fontawesome-webfont"; -$font-icon-version: "4.0.3"; - -//////////////////// -// OTHER -//////////////////// - -$nav-active-shadow: black; -$nav-footer-border-color: #666666; -$nav-embossed-border-top: black; -$nav-embossed-border-bottom: #939393; -$main-embossed-text-shadow: 0px 1px 0px white; -$search-box-border-color: #666666; - -//////////////////////////////////////////////////////////////////////////////// -// INTERNAL -//////////////////////////////////////////////////////////////////////////////// -// These settings are probably best left alone. -%break-words { - word-break: break-all; - /* Non standard for webkit */ - word-break: break-word; - hyphens: auto; -}